scim

Written for: ＋ Written for
Deprecated: ＋ Deprecated
Applies to: ＋ Applies to

AdminUpdated Sep 19, 2026

GEThttps://api.chatlychat.com/v1/scim/v2/ServiceProviderConfig

Parameters

Name	In	Type	Required	Description
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

200

Code samples

cURL

curl -X GET "https://api.chatlychat.com/v1/scim/v2/ServiceProviderConfig" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/ServiceProviderConfig', {
  method: 'GET',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.chatlychat.com/v1/scim/v2/ServiceProviderConfig",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/scim/v2/ServiceProviderConfig", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/ServiceProviderConfig');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/ServiceProviderConfig')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/ServiceProviderConfig"))
    .header("Idempotency-Key", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

GEThttps://api.chatlychat.com/v1/scim/v2/ResourceTypes

Parameters

Name	In	Type	Required	Description
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

200

Code samples

cURL

curl -X GET "https://api.chatlychat.com/v1/scim/v2/ResourceTypes" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/ResourceTypes', {
  method: 'GET',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.chatlychat.com/v1/scim/v2/ResourceTypes",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/scim/v2/ResourceTypes", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/ResourceTypes');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/ResourceTypes')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/ResourceTypes"))
    .header("Idempotency-Key", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

GEThttps://api.chatlychat.com/v1/scim/v2/Schemas

Parameters

Name	In	Type	Required	Description
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

200

Code samples

cURL

curl -X GET "https://api.chatlychat.com/v1/scim/v2/Schemas" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/Schemas', {
  method: 'GET',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.chatlychat.com/v1/scim/v2/Schemas",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/scim/v2/Schemas", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/Schemas');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/Schemas')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/Schemas"))
    .header("Idempotency-Key", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

GEThttps://api.chatlychat.com/v1/scim/v2/Users

Parameters

Name	In	Type	Required	Description
`filter`	query	string	yes
`startIndex`	query	string	yes
`count`	query	string	yes
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

200

Code samples

cURL

curl -X GET "https://api.chatlychat.com/v1/scim/v2/Users?filter=&startIndex=&count=" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/Users?filter=&startIndex=&count=', {
  method: 'GET',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.chatlychat.com/v1/scim/v2/Users?filter=&startIndex=&count=",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/scim/v2/Users?filter=&startIndex=&count=", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/Users?filter=&startIndex=&count=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/Users?filter=&startIndex=&count=')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/Users?filter=&startIndex=&count="))
    .header("Idempotency-Key", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

POSThttps://api.chatlychat.com/v1/scim/v2/Users

Parameters

Name	In	Type	Required	Description
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Request body application/json

{
  "schemas": [
    "string"
  ],
  "externalId": "string",
  "userName": "string",
  "name": {
    "givenName": "string",
    "familyName": "string",
    "formatted": "string"
  },
  "displayName": "string",
  "active": true,
  "emails": [
    {
      "value": "string",
      "primary": true
    }
  ]
}

Responses

201

Code samples

cURL

curl -X POST "https://api.chatlychat.com/v1/scim/v2/Users" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}'

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/Users', {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<value>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.chatlychat.com/v1/scim/v2/Users",
    headers={
    "Idempotency-Key": "<value>",
    "Content-Type": "application/json",
    },
    json={"schemas": ["string"], "externalId": "string", "userName": "string", "name": {"givenName": "string", "familyName": "string", "formatted": "string"}, "displayName": "string", "active": True, "emails": [{"value": "string", "primary": True}]},
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.chatlychat.com/v1/scim/v2/Users", strings.NewReader(`{"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}`))
	req.Header.Set("Idempotency-Key", "<value>")
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/Users');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/Users')
req = Net::HTTP::Post.new(uri)
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/Users"))
    .header("Idempotency-Key", "<value>")
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"schemas\":[\"string\"],\"externalId\":\"string\",\"userName\":\"string\",\"name\":{\"givenName\":\"string\",\"familyName\":\"string\",\"formatted\":\"string\"},\"displayName\":\"string\",\"active\":true,\"emails\":[{\"value\":\"string\",\"primary\":true}]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

GEThttps://api.chatlychat.com/v1/scim/v2/Users/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

200

Code samples

cURL

curl -X GET "https://api.chatlychat.com/v1/scim/v2/Users/{id}" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/Users/{id}', {
  method: 'GET',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.chatlychat.com/v1/scim/v2/Users/{id}",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/scim/v2/Users/{id}", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/Users/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/Users/{id}')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/Users/{id}"))
    .header("Idempotency-Key", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

PUThttps://api.chatlychat.com/v1/scim/v2/Users/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Request body application/json

{
  "schemas": [
    "string"
  ],
  "externalId": "string",
  "userName": "string",
  "name": {
    "givenName": "string",
    "familyName": "string",
    "formatted": "string"
  },
  "displayName": "string",
  "active": true,
  "emails": [
    {
      "value": "string",
      "primary": true
    }
  ]
}

Responses

200

Code samples

cURL

curl -X PUT "https://api.chatlychat.com/v1/scim/v2/Users/{id}" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}'

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/Users/{id}', {
  method: 'PUT',
  headers: {
    'Idempotency-Key': '<value>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "PUT",
    "https://api.chatlychat.com/v1/scim/v2/Users/{id}",
    headers={
    "Idempotency-Key": "<value>",
    "Content-Type": "application/json",
    },
    json={"schemas": ["string"], "externalId": "string", "userName": "string", "name": {"givenName": "string", "familyName": "string", "formatted": "string"}, "displayName": "string", "active": True, "emails": [{"value": "string", "primary": True}]},
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("PUT", "https://api.chatlychat.com/v1/scim/v2/Users/{id}", strings.NewReader(`{"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}`))
	req.Header.Set("Idempotency-Key", "<value>")
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/Users/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/Users/{id}')
req = Net::HTTP::Put.new(uri)
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"schemas":["string"],"externalId":"string","userName":"string","name":{"givenName":"string","familyName":"string","formatted":"string"},"displayName":"string","active":true,"emails":[{"value":"string","primary":true}]}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/Users/{id}"))
    .header("Idempotency-Key", "<value>")
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"schemas\":[\"string\"],\"externalId\":\"string\",\"userName\":\"string\",\"name\":{\"givenName\":\"string\",\"familyName\":\"string\",\"formatted\":\"string\"},\"displayName\":\"string\",\"active\":true,\"emails\":[{\"value\":\"string\",\"primary\":true}]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

DELETEhttps://api.chatlychat.com/v1/scim/v2/Users/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

204

Code samples

cURL

curl -X DELETE "https://api.chatlychat.com/v1/scim/v2/Users/{id}" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/Users/{id}', {
  method: 'DELETE',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "DELETE",
    "https://api.chatlychat.com/v1/scim/v2/Users/{id}",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.chatlychat.com/v1/scim/v2/Users/{id}", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/Users/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/Users/{id}')
req = Net::HTTP::Delete.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/Users/{id}"))
    .header("Idempotency-Key", "<value>")
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

PATCHhttps://api.chatlychat.com/v1/scim/v2/Users/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Request body application/json

{
  "schemas": [
    "string"
  ],
  "Operations": [
    {
      "op": "string",
      "path": "string",
      "value": {}
    }
  ],
  "operations": [
    {
      "op": "string",
      "path": "string",
      "value": {}
    }
  ]
}

Responses

200

Code samples

cURL

curl -X PATCH "https://api.chatlychat.com/v1/scim/v2/Users/{id}" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"schemas":["string"],"Operations":[{"op":"string","path":"string","value":{}}],"operations":[{"op":"string","path":"string","value":{}}]}'

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/scim/v2/Users/{id}', {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<value>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"schemas":["string"],"Operations":[{"op":"string","path":"string","value":{}}],"operations":[{"op":"string","path":"string","value":{}}]}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "PATCH",
    "https://api.chatlychat.com/v1/scim/v2/Users/{id}",
    headers={
    "Idempotency-Key": "<value>",
    "Content-Type": "application/json",
    },
    json={"schemas": ["string"], "Operations": [{"op": "string", "path": "string", "value": {}}], "operations": [{"op": "string", "path": "string", "value": {}}]},
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.chatlychat.com/v1/scim/v2/Users/{id}", strings.NewReader(`{"schemas":["string"],"Operations":[{"op":"string","path":"string","value":{}}],"operations":[{"op":"string","path":"string","value":{}}]}`))
	req.Header.Set("Idempotency-Key", "<value>")
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/scim/v2/Users/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"schemas":["string"],"Operations":[{"op":"string","path":"string","value":{}}],"operations":[{"op":"string","path":"string","value":{}}]}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/scim/v2/Users/{id}')
req = Net::HTTP::Patch.new(uri)
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"schemas":["string"],"Operations":[{"op":"string","path":"string","value":{}}],"operations":[{"op":"string","path":"string","value":{}}]}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/scim/v2/Users/{id}"))
    .header("Idempotency-Key", "<value>")
    .header("Content-Type", "application/json")
    .method("PATCH", BodyPublishers.ofString("{\"schemas\":[\"string\"],\"Operations\":[{\"op\":\"string\",\"path\":\"string\",\"value\":{}}],\"operations\":[{\"op\":\"string\",\"path\":\"string\",\"value\":{}}]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Was this page helpful?