The DELETE /users/{userId}
endpoint deletes the user matching the user ID provided.
Tip |
---|
The target user must be archived before deletion. The API user must be an admin to delete another user. |
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Insert excerpt _ExcerptAPICloudNextGen _ExcerptAPICloudNextGen nopanel true
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
Scope | Access granted |
---|---|
users:write | Entire endpoint |
Parameters
The endpoint accepts the following path parameter:
...
Type | Required | Example |
---|---|---|
String | True | 8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
The user ID of the user to delete.
Requests
Delete individual user
Code Block | ||||
---|---|---|---|---|
| ||||
curl -L -X DELETE "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Successful response
Successful requests return a 200 Success
code.