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

NameTypeSampleExplanation
name
post
stringService agreementTemplate name. Alias: title.

Optional Parameters

NameTypeSampleWhat it gives
original_filename
post
stringagreement.pdfSource PDF path/name. Aliases: pdf_file, pdf_file1.
filename
post
stringpage1.jpg,page2.jpgComma-separated page image paths. Aliases: pages, file_arr.
field_position
post
json[]Signature/field positions JSON.
pdf_total_page
post
int2Total pages. Default 1.
data_width
post
int800Page width.
data_height
post
int1131Page height.
signature_total
post
int1Number of signatures. Default 1.
language
post
stringheLanguage code.
add_stamp
post
int0Add stamp flag.
add_signature_page_in_different_page
post
int0Separate signature page flag.
status
post
int1Template 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.Add

Sample 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"
}