POST
PdfSigner.Edit
Update a PDF Signer template. Send pdf_signer_id plus only fields to change. Alias: PdfSigner.Update. Requires owner or member-admin. Emits realtime pdfsigner.updated.
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 PdfSigner record after validating permissions and input fields.
Push Service
Pushes event pdfsigner.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.
- 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 |
|---|---|---|---|
pdf_signer_idpost | int | 12 | Template id. Aliases: id, data_id, update_id, pdf_signer. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
namepost | string | Service agreement v2 | Updated name. Alias: title. |
original_filenamepost | string | agreement.pdf | Source PDF path/name. Aliases: pdf_file, pdf_file1. |
filenamepost | string | page1.jpg,page2.jpg | Comma-separated page image paths. Aliases: pages, file_arr. |
field_positionpost | json | [] | Signature/field positions JSON. |
pdf_total_pagepost | int | 2 | Total pages. |
data_widthpost | int | 800 | Page width. |
data_heightpost | int | 1131 | Page height. |
signature_totalpost | int | 1 | Number of signatures. |
languagepost | string | he | Language code. |
add_stamppost | int | 0 | Add stamp flag. |
add_signature_page_in_different_pagepost | int | 0 | Separate signature page flag. |
statuspost | int | 1 | Template status. |
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\/PdfSigner.Edit",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"pdf_signer_id": "12",
"name": "Service agreement v2"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/PdfSigner.Edit",
"url_domain": "https:\/\/{domain}\/app\/PdfSigner.Edit"
}Endpoint
POST /app/PdfSigner.Edit
POST https://{user}.bull36.com/app/PdfSigner.Edit
POST https://{domain}/app/PdfSigner.EditSample Output
{
"success": 1,
"id": 12,
"pdf_signer_id": 12,
"message": "PDF Signer updated successfully.",
"socket_event": "pdfsigner.updated"
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ pdf_signer_id: '12', name: 'Service agreement v2' });
const res = await fetch('/app/PdfSigner.Edit', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());Error Example
{
"success": 0,
"message": "PDF Signer not found."
}