POST

Documents.Edit

Update an uploaded customer file note/display name or folder. This edits file metadata only; it does not replace the physical file or edit invoice/receipt document contents.

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 Documents record after validating permissions and input fields.

Push Service

No push is sent because this function only reads data or returns helper information.

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_id
post
int456Document/file id. You may also send update_client_file_data or file_id.
folder
post
string|intdefaultNew folder/type.

Optional Parameters

NameTypeSampleWhat it gives
folder_value
post
string|intold_folderPrevious folder value used by the UI.
note
post
stringUpdated contract nameNew file note/display name. You may also send update_client_file.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Documents.Edit",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "document_id": "456",
        "folder": "default",
        "note": "Updated contract name"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Documents.Edit",
    "url_domain": "https:\/\/{domain}\/app\/Documents.Edit"
}

Endpoint

POST /app/Documents.Edit
POST https://{user}.bull36.com/app/Documents.Edit
POST https://{domain}/app/Documents.Edit

Sample Output

{
    "success": "1",
    "message": "Your File Update",
    "update_data_id": "456"
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({
  document_id: '456',
  folder: 'default',
  note: 'Updated contract name'
});

const res = await fetch('/app/Documents.Edit', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + token },
  body
});

const data = await res.json();
console.log(data);

Error Example

{
    "success": "0",
    "message": "Please try again later"
}