Update Document Settings | propelone

Request

This endpoint expects a multipart form.

user_idstringRequired

Optional: Tenant user UUID to scope the override at user-tier - omit for location-tier (when location header present) or tenant-tier

pdf_paper_sizestringRequired

Optional: PDF page size for rendered documents - in: A4|LETTER

allow_sms_dispatchstringRequired

Optional: Allow SMS channel - boolean true|false|1|0

allow_decline_actionstringRequired

Optional: Allow recipients to decline a dispatch via the public link - boolean true|false|1|0

allow_email_dispatchstringRequired

Optional: Allow email channel for dispatches - boolean true|false|1|0

allow_portal_dispatchstringRequired

Optional: Allow customer portal channel - boolean true|false|1|0

allow_postal_dispatchstringRequired

Optional: Allow postal-mail channel - boolean true|false|1|0

allow_external_recipientsstringRequired

Optional: Allow non-CRM recipients (snapshot-only) - boolean true|false|1|0

public_page_support_emailstringRequired

Optional: Support email rendered on the public page - valid email - max 255 chars

public_page_support_phonestringRequired

Optional: Support phone rendered on the public page - max 64 chars

public_page_welcome_messagestringRequired

Optional: Welcome banner shown on the public signing page - max 5000 chars

bulk_dispatch_max_recipientsstringRequired

Optional: Maximum recipients per bulk dispatch - integer 1-50000 - default: env config

default_dispatch_expiry_daysstringRequired

Optional: Default dispatch lifetime in days - integer 1-3650

pdf_include_audit_certificatestringRequired

Optional: Append a tamper-evident audit certificate page on COMPLETED dispatch PDFs - boolean true|false|1|0

pdf_include_company_letterheadstringRequired

Optional: Render the tenant company letterhead on rendered PDFs - boolean true|false|1|0

archived_dispatch_retention_daysstringRequired

Optional: Retention window for ARCHIVED dispatches in days - integer 1-36500

completed_dispatch_retention_daysstringRequired

Optional: Retention window for COMPLETED dispatches in days - integer 1-36500

public_signing_link_validity_hoursstringRequired

Optional: Validity window of the public signed signing URL in hours - integer 1-8760 - default: env config

default_fifth_reminder_at_t_minus_daysstringRequired

Optional: Default fifth reminder offset - integer 0-365

default_first_reminder_at_t_minus_daysstringRequired

Optional: Default first reminder offset in days before expiry - integer 0-365

default_third_reminder_at_t_minus_daysstringRequired

Optional: Default third reminder offset - integer 0-365

default_fourth_reminder_at_t_minus_daysstringRequired

Optional: Default fourth reminder offset - integer 0-365

default_second_reminder_at_t_minus_daysstringRequired

Optional: Default second reminder offset - integer 0-365

require_acknowledgment_for_uploaded_pdfsstringRequired

Optional: Force acknowledgment on UPLOADED documents that have no signing fields - boolean true|false|1|0

Response

Successful response

1	curl -X PUT https://https//https/companies/%7Bcompany_id%7D/config/documents/settings \
2	-H "{{tenant_key_name}}: {{tenant_key_value1}}\|{{tenant_key_value2}}" \
3	-H "Content-Type: multipart/form-data" \
4	-F user_id="a3f1c9d2-4b7e-4f8a-9c3d-2e5f7a1b6c8d" \
5	-F pdf_paper_size="A4" \
6	-F allow_sms_dispatch="true" \
7	-F allow_decline_action="false" \
8	-F allow_email_dispatch="true" \
9	-F allow_portal_dispatch="true" \
10	-F allow_postal_dispatch="false" \
11	-F allow_external_recipients="true" \
12	-F public_page_support_email="support@propelbiz.com" \
13	-F public_page_support_phone="+1-800-555-0199" \
14	-F public_page_welcome_message="Welcome to PropelBiz Document Signing Portal. Please review and sign your documents securely." \
15	-F bulk_dispatch_max_recipients="1000" \
16	-F default_dispatch_expiry_days="30" \
17	-F pdf_include_audit_certificate="true" \
18	-F pdf_include_company_letterhead="true" \
19	-F archived_dispatch_retention_days="3650" \
20	-F completed_dispatch_retention_days="1825" \
21	-F public_signing_link_validity_hours="168" \
22	-F default_fifth_reminder_at_t_minus_days="1" \
23	-F default_first_reminder_at_t_minus_days="14" \
24	-F default_third_reminder_at_t_minus_days="7" \
25	-F default_fourth_reminder_at_t_minus_days="3" \
26	-F default_second_reminder_at_t_minus_days="10" \
27	-F require_acknowledgment_for_uploaded_pdfs="false"

Headers

Request

Response