POST
PdfSigner.Add
Create a PDF Signer template (Settings → New PDF Signer / pdf_signer_save insert). Requires owner or member-admin. Expects prepared file paths (original_filename / filename pages) as after dashboard PDF raster upload — this route does not upload or convert PDFs. Emits realtime pdfsigner.created.
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
- Creates a PdfSigner record or sends the requested data after validation.
Push Service
Pushes event pdfsigner.created to users who should see this change.
Automation
No automation is run for this function.
Special Instructions
- Upload/rasterize the PDF in the dashboard (or supply filename page paths) before Add if you need page images.
- field_position may be a JSON array/object string of signature field placements.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
namepost | string | Service agreement | Template name. Alias: title. |
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
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. Default 1. |
data_widthpost | int | 800 | Page width. |
data_heightpost | int | 1131 | Page height. |
signature_totalpost | int | 1 | Number of signatures. Default 1. |
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. Default 1. |
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/PdfSigner.Add",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"name": "Service agreement",
"original_filename": "agreement.pdf",
"filename": "page1.jpg,page2.jpg",
"pdf_total_page": "2",
"signature_total": "1",
"language": "he",
"field_position": "[]"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/PdfSigner.Add",
"url_domain": "https:\/\/{domain}\/app\/PdfSigner.Add"
}Endpoint
POST /app/PdfSigner.Add
POST https://{user}.bull36.com/app/PdfSigner.Add
POST https://{domain}/app/PdfSigner.AddSample Output
{
"success": 1,
"id": 12,
"pdf_signer_id": 12,
"message": "PDF Signer added successfully.",
"socket_event": "pdfsigner.created",
"data": {
"id": 12,
"name": "Service agreement"
}
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({
name: 'Service agreement',
original_filename: 'agreement.pdf',
filename: 'page1.jpg,page2.jpg',
pdf_total_page: '2'
});
const res = await fetch('/app/PdfSigner.Add', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());Error Example
{
"success": 0,
"message": "Missing required parameter: name"
}