DELETE /api/org/clients/:id
Deletes the client: the reference, birth date and every order's brief and document are erased, an open order refused. Charges stay for the books.
Surface: organisation. Who may call: organisation-key. Key: organisation.clients.remove.
Example request
curl -X DELETE https://caremcp.com/api/org/clients/7d1f0a0e-2c4b-4c7e-9a6e-000000000001 \
-H "Authorization: Bearer <API key or session>"
Example input
{
"id": "7d1f0a0e-2c4b-4c7e-9a6e-000000000001"
}
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"id"
]
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"const": true
}
},
"required": [
"ok"
],
"additionalProperties": false
}