Post
/api/v1/custom-user-status.delete
Delete a custom user status. Permission required: manage-user-status
Changelog
| Version | Description |
|---|---|
| 2.4.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
"customUserStatusId": "65462e97a2f73c7460e18f84"
}object
customUserStatusId
string Required
The _id of the custom status
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
User status Id is required:
{
"success": false,
"error": "The \"customUserStatusId\" params is required!"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string