Deskhero Developer Hub
Back to deskhero.com
Users

Activate deactivate

Sets a User's membership status on this workspace to ACTIVE or DEACTIVE, which is applied through the billing seat trigger, so it changes what the workspace is billed for. The User account itself is not deleted and keeps its groups and role. Sending the status the User already has is rejected, and the last remaining owner cannot be deactivated.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/users/activate_deactivate/{id}
Authorisation
Minimum role: ADMIN

Request arguments

Name Type Source
idInt32
inputDTO_user_activate_deactivateBody
Request body example

Response

Status
200 (OK)
Type
DTO_acknowledgement
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_user_activate_deactivate
NameTypeReadOnlyDescription
statusENUM tenant_user_statusStatus
DTO_acknowledgement
NameTypeReadOnlyDescription
messageStringMessage
ENUM tenant_user_status
ValueNameDescription
0UNKNOWNUNKNOWN
1ACTIVEACTIVE
2DEACTIVEDEACTIVE

Generated Aug 4, 2026 18:37