Archive a user

Archive an existing user. In the response, the archived field is set as true.

You can restore an archived user with POST /v3/users/{userId}/restore. There is no change when you archive an archived user.

This operation requires partner-level permissions.

  • A sessionId header value generated with API partner login
  • An appKey header value
  • The organizationId of the organization
Click Try It! to start a request and see the response here!