Deactivate multiple users

Deactivates one or more users on Mindtickle by Mindtickle user ID or by username.

Prerequisites

Authentication and setup: A valid access token.
Create a user: The users must exist.

Endpoint

POST /services/data/v4.0/mtobjects/Users/delete

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.

Request

The body is an array of objects, one object per user.

Parameter	Type	Required	Description
`id`	string	Required if `username` is not sent	Mindtickle user ID of the user you want to deactivate.
`username`	string	Required if `id` is not sent	Username of the user you want to deactivate.

Request example

By Mindtickle user ID:

[
  {
    "id": "123456789abcd101"
  },
  {
    "id": "123456789abcd102"
  },
  {
    "id": "123456789abcd103"
  }
]

By username:

[
  {
    "username": "alex.fry@example.com"
  },
  {
    "username": "anna.cruz@example.com"
  },
  {
    "username": "rosalia.flores@example.com"
  }
]

Response

Field	Type	Description
`processIds`	Array[string]	Mindtickle process IDs. Use them to check the status of a request.

Response example

{
  "processIds": ["1234567890123456104"]
}

Notes

Async processing: The request is queued, and the response returns process IDs you use to check the result.
Validation: Provide either the Mindtickle user IDs or the usernames, not a mix of both.
Usernames: When you provide usernames, provide the username of each user if UID is enabled for your Mindtickle instance, and their email address if UID is not enabled.