How to: Change State of a User

To change the state of a User, call the User State Transition endpoint and pass the following parameters in the request body:

toStateOne of the valid state codes: onboarding, active, deboarding, or inactive.
reasonCode (optional)A valid reason code associated with the event.
data (optional)Any additional information about the transition.

Request bodies are specified in JSON format. The following example request body shows how to change the state of the User:

  "toState": "active:available",
  "reasonCode": "R-104",
  "data": {}