API reference › General settings › Identities
Delete a custom identity
DELETE /v1/identities/{identity}
- Scope
settings_general:delete- Roles
- admin, scheduler
Archive a custom identity by ID. Default entries (isCustom false) can't be deleted.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
identity required | integer | ID of the identity to delete. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl -X DELETE "https://api.fetchfido.ai/v1/identities/{identity}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Identity deleted successfully
Identity deleted successfully.
{
"success": true,
"message": "Custom identity Late-deafened (10) was deleted successfully.",
"data": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object or null |
400 Bad request
The entry is a default, or archived.
{
"success": false,
"message": "Default identities can't be deleted.",
"errors": "Failed to delete.",
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string | Example |
code | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'settings_general:delete' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
422 Validation failed
An unknown id.
{
"success": false,
"message": "Unable to save. Please check the highlighted fields",
"errors": {
"id": [
"Identity not found."
]
},
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
code | string | Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error.
{
"success": false,
"message": "Something went wrong!",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | The underlying error, in debug mode only. |
code | string | Example |