End Users
Delete end user
Permanently delete an end user. This removes their record from the system. Note that if they interact with a widget again, a new end user record may be created automatically.
DELETE
/
end-users
/
{id}
Delete end user
curl --request DELETE \
--url https://app.usechar.ai/api/end-users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://app.usechar.ai/api/end-users/{id}"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://app.usechar.ai/api/end-users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.usechar.ai/api/end-users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.usechar.ai/api/end-users/{id}"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://app.usechar.ai/api/end-users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.usechar.ai/api/end-users/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"defined": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "Invalid request data",
"data": {
"code": "VALIDATION_ERROR",
"field": "email",
"details": "Invalid email format"
}
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": {
"code": "AUTH_REQUIRED"
}
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "Access denied",
"data": {
"code": "ACCESS_DENIED",
"reason": "Insufficient permissions"
}
}{
"defined": true,
"code": "NOT_FOUND",
"status": 404,
"message": "Resource not found",
"data": {
"code": "RESOURCE_NOT_FOUND",
"resource": "site",
"resourceId": "site_123"
}
}{
"defined": true,
"code": "CONFLICT",
"status": 409,
"message": "Resource already exists",
"data": {
"code": "DUPLICATE_RESOURCE",
"resource": "api_key"
}
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An internal error occurred",
"data": {
"code": "INTERNAL_ERROR"
}
}Authorizations
WorkOS JWT token. Obtain via WorkOS AuthKit authentication flow. The token must include organization_id claim for organization-scoped endpoints.
Path Parameters
Unique identifier (UUID) of the resource
Body
application/json
The body is of type object.
Response
OK
Response schema for delete operations
Indicates whether the deletion was successful
⌘I
Delete end user
curl --request DELETE \
--url https://app.usechar.ai/api/end-users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://app.usechar.ai/api/end-users/{id}"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://app.usechar.ai/api/end-users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.usechar.ai/api/end-users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.usechar.ai/api/end-users/{id}"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://app.usechar.ai/api/end-users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.usechar.ai/api/end-users/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"defined": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "Invalid request data",
"data": {
"code": "VALIDATION_ERROR",
"field": "email",
"details": "Invalid email format"
}
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": {
"code": "AUTH_REQUIRED"
}
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "Access denied",
"data": {
"code": "ACCESS_DENIED",
"reason": "Insufficient permissions"
}
}{
"defined": true,
"code": "NOT_FOUND",
"status": 404,
"message": "Resource not found",
"data": {
"code": "RESOURCE_NOT_FOUND",
"resource": "site",
"resourceId": "site_123"
}
}{
"defined": true,
"code": "CONFLICT",
"status": 409,
"message": "Resource already exists",
"data": {
"code": "DUPLICATE_RESOURCE",
"resource": "api_key"
}
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An internal error occurred",
"data": {
"code": "INTERNAL_ERROR"
}
}
