POST
Documents.SignLink
Alias of Documents.ApproveSign.Link — returns the public approve/sign browser URL for a proposal/order document.
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.SignLink 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
- 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.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
document_idpost | int | 1627 | documents.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.SignLink",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"document_id": "1627"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Documents.SignLink",
"url_domain": "https:\/\/{domain}\/app\/Documents.SignLink"
}Endpoint
POST /app/Documents.SignLink
POST https://{user}.bull36.com/app/Documents.SignLink
POST https://{domain}/app/Documents.SignLinkSample Output
{
"success": 1,
"sign_link": "https:\/\/user.bull36.com\/dashboard\/home\/invoice-payment-cc\/...."
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('document_id', '1627');
const res = await fetch('/app/Documents.SignLink', {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
body
});
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"message": "Document not found"
}