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

NameTypeSampleExplanation
pdf_signer_id
post
int12Template id. Aliases: id, data_id, update_id, pdf_signer.

Optional Parameters

NameTypeSampleWhat it gives
name
post
stringService agreement v2Updated name. Alias: title.
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.
data_width
post
int800Page width.
data_height
post
int1131Page height.
signature_total
post
int1Number of signatures.
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.

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.Edit

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