POST

DocumentStatuses.Remove

Same as DocumentStatuses.Delete.

Permissions

  • User must be logged in with a valid bearer token.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Removes the requested DocumentStatuses record when the user has permission.

Push Service

Pushes event documentstatuses.delete.deleted to users who should see this change.

Automation

No automation is run for this function.

Special Instructions

  • Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
  • Send parameters as POST body fields exactly as documented.

Required Parameters

NameTypeSampleExplanation
document_status_id
post
int3453Row id. Aliases: status_id, id, data_id.

Optional Parameters

No optional body parameters are defined for this function.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/DocumentStatuses.Remove",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "document_status_id": "3453"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/DocumentStatuses.Remove",
    "url_domain": "https:\/\/{domain}\/app\/DocumentStatuses.Remove"
}

Endpoint

POST /app/DocumentStatuses.Remove
POST https://{user}.bull36.com/app/DocumentStatuses.Remove
POST https://{domain}/app/DocumentStatuses.Remove

Sample Output

{
    "success": 1,
    "message": "Success",
    "document_status_id": 3453,
    "socket_event": "documentstatuses.delete.deleted"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ document_status_id: '3453' });
const res = await fetch('/app/DocumentStatuses.Remove', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());

Error Example

{
    "success": 0,
    "message": "Document status not found"
}