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.
- The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
- 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.
- On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
- 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
| Name | Type | Sample | Explanation |
|---|---|---|---|
document_idpost | int | 456 | Document/file id. You may also send update_client_file_data or file_id. |
folderpost | string|int | default | New folder/type. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
folder_valuepost | string|int | old_folder | Previous folder value used by the UI. |
notepost | string | Updated contract name | New file note/display name. You may also send update_client_file. |
Authentication
Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).
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.EditSample 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"
}