Version 2021
Deactivate a User
Deactivates a user account.
POST /api/v1//user/deactivate
Additional Error Code: USER_NOT_FOUND
Example call
curl -X POST 'https://usher-endpoint.com/api/v1/user/deactivate' -H 'Authorization: Bearer [servicetoken]' -H 'Content-Type: application/json' -d '{ "userId": "[user id]", "userIdType": "[user id type]","requester": "Kintaro", "locale": "en"}'
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | ts | Unix time | string |
Body | body (required) | Credentials | body |
body
Name | Description | Schema |
---|---|---|
locale (required) | Locale | string |
requester (required) | Requester | string |
userId | Email address or phone number. | string |
userIdType | Email or mobile. Email will be used by default. | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | Successful transaction | Response 200 |
400 | Invalid Request | Response 400 |
500 | ErrorResponseInternalServerError |
Response 200
Name | Description | Schema |
---|---|---|
localizedMessage | Example : " " | string |
reason | Example : " " | string |
status | enum (OK) |
Response 400
Name | Description | Schema |
---|---|---|
localizedMessage | Example : "invalid token" | string |
reason | Example : "invalid_token " | string |
status | Example : "INVALID_TOKEN" | string |
Consumes
application/json
Produces
application/json
Security
Type | Name |
---|---|
apiKey | ServiceAuth |