POST
Documents.Approve
Approve one or more order_proposals / purchase_orders / detail_orders without a customer signature image. Same as the dashboard Approve checkbox on the customer Orders/Proposals list. Rebuilds PDF and runs the same post-approve email / auto-create / automation rules as the dashboard.
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
- Runs the Documents.Approve function and returns JSON.
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
- Staff bearer token only (not Customer.Login).
- Send document_ids as array, comma list, or a single document_id.
- Already-approved rows are skipped.
- For customer canvas signature use Documents.ApproveSign.
- User must be from the same company domain as the request Host.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
document_idspost | string | 1627,1628 | Document ids to approve. Aliases: order_proposals_id[], ids, document_id, id. |
Optional Parameters
No optional body parameters are defined for this function.
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.Approve",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"document_ids": "1627"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Documents.Approve",
"url_domain": "https:\/\/{domain}\/app\/Documents.Approve"
}Endpoint
POST /app/Documents.Approve
POST https://{user}.bull36.com/app/Documents.Approve
POST https://{domain}/app/Documents.ApproveSample Output
{
"success": 1,
"message": "Success",
"approved_ids": [
1627
],
"skipped_ids": []
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('document_ids', '1627');
const res = await fetch('/app/Documents.Approve', {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
body
});
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"message": "Document not found"
}