Remove user
Removes a user's access to an organization or profile. Requires admin role. You cannot remove yourself or remove the last admin.
Path Parameters
userId*string
Header Parameters
x-profile-id?string
Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
sandbox?boolean
Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://api-dev.sent.dm/v3/users/string" \ -H "Content-Type: application/json" \ -d '{ "sandbox": false }'Empty
{
"success": false,
"data": null,
"error": {
"code": "VALIDATION_001",
"message": "You cannot remove yourself from the organization",
"details": null,
"doc_url": "https://docs.sent.dm/docs/reference/api/error-catalog"
},
"meta": {
"request_id": "req_7X9zKp2jDw",
"timestamp": "2026-03-25T10:43:34.2097891+00:00",
"version": "v3"
}
}Empty
{
"success": false,
"data": null,
"error": {
"code": "AUTH_004",
"message": "You do not have admin access to this organization or profile",
"details": null,
"doc_url": "https://docs.sent.dm/docs/reference/api/authentication"
},
"meta": {
"request_id": "req_7X9zKp2jDw",
"timestamp": "2026-03-25T10:43:34.2097919+00:00",
"version": "v3"
}
}{
"success": false,
"data": null,
"error": {
"code": "RESOURCE_006",
"message": "User not found",
"details": null,
"doc_url": "https://docs.sent.dm/docs/reference/api/error-catalog"
},
"meta": {
"request_id": "req_7X9zKp2jDw",
"timestamp": "2026-03-25T10:43:34.2097925+00:00",
"version": "v3"
}
}{
"success": false,
"data": null,
"error": {
"code": "INTERNAL_001",
"message": "An unexpected error occurred. Please contact support with request ID: req_7X9zKp2jDw",
"details": null,
"doc_url": "https://docs.sent.dm/docs/reference/api/error-catalog"
},
"meta": {
"request_id": "req_7X9zKp2jDw",
"timestamp": "2026-03-25T10:43:34.2097931+00:00",
"version": "v3"
}
}