Deactivate a user
Deactivates a user on Mindtickle by Mindtickle user ID.
Prerequisites
- Authentication and setup: A valid access token.
- Create a user: The user must exist.
Endpoint
Section titled “Endpoint”DELETE /services/data/v4.0/mtobjects/User/USER_IDBase URL: the standard REST host for your region. See Base URLs.
Headers: Authorization: Bearer ACCESS_TOKEN.
Path parameters
Section titled “Path parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
USER_ID |
string | Required | Mindtickle ID of the user. |
Request
Section titled “Request”This endpoint has no request body.
Response
Section titled “Response”| Field | Type | Description |
|---|---|---|
requestId |
string or null | Request identifier. The response examples return null. |
responseCode |
integer | Special response codes from the server. |
responseType |
string | Type of response from the server. |
taskCompleted |
boolean | Flag for task completion. true means the task is successfully queued in Mindtickle. |
processIds |
Array[string] | Mindtickle process IDs. Use them to check the status of a request. |
Response example
Section titled “Response example”{ "requestId": null, "responseCode": 0, "responseType": "BULK_RESPONSE", "taskCompleted": true, "processIds": ["1234567890123456101"]}- Async processing: The request is queued, and the response returns process IDs you use to check the result.
- Reactivation: Updating profile fields for a deactivated learner through the user APIs reactivates the learner.