HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

User / Change Status

Set the status for a user

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

the user ID to change the status of

Body Params
string
enum
required
  • enabled Enabled - the user is allowed to use the system
  • disabled Disabled - the user is NOT allowed to use the system
Allowed:
string
required
churnReason
object

Optional churn reason stored on the user's exit in the churn record. Only allowed with status disabled; sending it with enabled returns a validation error. The reason must apply to users. Custom reasons allow the chose_to_leave, forced and circumstances_changed exit types. Send an empty object or omit it to record no reason. Without it, disabling records the exit as forced with no reason. It is not included in the Audit logs.

Responses
202

Action accepted

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json