API reference › Clients

Delete a client

DELETE /v1/clients/{client}

Scope
clients:delete
Roles
admin, scheduler

Deletes a specific client by ID. This will remove the client and all associated data such as locations, documents, and preferences.

Parameters

Path parameters

NameTypeDescription
client requiredstring

The ID of the client to delete.

Example CLT-IXRJBO.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
curl -X DELETE "https://api.fetchfido.ai/v1/clients/{client}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Client deleted successfully

Client deleted successfully

JSON
{
  "success": true,
  "message": "Client deleted successfully!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Client deleted successfully!.

400 Bad request

Bad Request - Invalid input data

JSON
{
  "success": false,
  "message": "Invalid parameters. Ensure the client ID exists."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid parameters. Ensure the client ID exists..

401 Not signed in

Unauthorized - Authentication required

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'clients:delete' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'clients:delete' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Not Found - Client does not exist

JSON
{
  "success": false,
  "message": "Client not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Client not found..

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal Server Error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..