POST

DocumentStatuses.Update

Same as DocumentStatuses.Edit.

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

  • Updates the requested DocumentStatuses record after validating permissions and input fields.

Push Service

Pushes event documentstatuses.edit.updated 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.
  • Send date/time values in UTC Y-m-d H:i:s format when a date or datetime field is used.

Required Parameters

NameTypeSampleExplanation
document_status_id
post
int3453Row id. Aliases: status_id, id, all_document_status_id.
name_en
post
stringIn ProductionEnglish name. Alias: all_document_statuses_en.
name_he
post
stringIn ProductionHebrew name. Alias: all_document_statuses_he.

Optional Parameters

NameTypeSampleWhat it gives
color
post
string#c48bb8Color hex.
type_for
post
stringpurchase_orderstype_for. Default purchase_orders.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/DocumentStatuses.Update",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "document_status_id": "3453",
        "name_en": "In Production",
        "name_he": "In Production",
        "color": "#c48bb8"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/DocumentStatuses.Update",
    "url_domain": "https:\/\/{domain}\/app\/DocumentStatuses.Update"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "message": "Your document status is updated",
    "document_status_id": 3453,
    "socket_event": "documentstatuses.edit.updated"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ document_status_id: '3453', name_en: 'In Production', name_he: 'In Production', color: '#c48bb8' });
const res = await fetch('/app/DocumentStatuses.Update', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());

Error Example

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