Suspend user

Foreword

HTTP method : PATCH

v2/users/{userId}

The userId parameter allows you to define the user you need to update.

Parameter	Description	Format
userId	User Id	String

Request body

{
  "users": [
    {
      "suspensionStartDate": "2025-06-24T11:46:06.672Z"
    }
  ]
}

Suspend the user from the selected date. In order to suspend a user set the suspensionStartDate in the future or with the D day. To reactivate a suspended user, set the suspensionStartDate to null.

Response

200 OK

{
  "suspensionStartDate": "2025-06-24T11:46:06.672Z",
  "lastName": "string",
  "firstName": "string",
  "email": "string",
  "id": "string"
}