Delete custom user status

URL
Requires Auth
HTTP Method
api/v1/custom-user-status.delete
YES
POST
Headers
Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)
Example Call
1
curl --location --request POST 'http://localhost:3000/api/v1/custom-user-status.delete\
2
--header 'X-Auth-Token: myauth-token' \
3
--header 'X-User-Id: myuser-name'
4
 -d "customUserStatusId=EscbQinc8jmeXbpt7"
Copied!
Result
Success
1
{
2
    "success": true
3
}
Copied!
Errors
Any of the following errors can occur upon the endpoint.
Authorization: Requires an authentication token for the request to be made.
customUserStatusId param: Requires a custom user status customUserStatusId.
 Authorization
customUserStatusId pram
1
{
2
    "success": false,
3
    "error": "unauthorized"
4
}
Copied!
​
1
{
2
    "success": false,
3
    "error": "The \"customUserStatusId\" params is required!"
4
}
Copied!
​

Create custom user status

Update custom user status type

Last modified 7mo ago

Export as PDF

Copy link

Edit on GitHub

Contents