Update Document

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
namestringRequired

Optional: Document name - max 255 chars

body_htmlstringRequired

Optional: HTML body for COMPOSED documents - string

descriptionstringRequired

Optional: Long-form description - max 5000 chars

template_idstringRequired

Optional: New template UUID for TEMPLATED documents - exists:templates,id

effective_tostringRequired

Optional: Effective-to date - after_or_equal effective_from

authoring_modestringRequired

Optional: Authoring mode - in: UPLOADED|COMPOSED|TEMPLATED

effective_fromstringRequired

Optional: Effective-from date

document_type_idstringRequired

Optional: Document type UUID - exists:document_types,id

requires_signaturestringRequired

Optional: Signature requirement - boolean true|false|1|0

default_expiry_daysstringRequired

Optional: Default expiry days - integer 1-3650

expected_signer_rolestringRequired

Optional: Expected signer role - in: CUSTOMER|TENANT|PROPERTY_MANAGER|AUTHORIZED_REPRESENTATIVE|TECHNICIAN|SUBCONTRACTOR|INSPECTOR|SUPERVISOR|COMPANY_REPRESENTATIVE|WITNESS|OTHER

source_attachment_idstringRequired

Optional: New source PDF attachment UUID - exists:attachments,id

requires_acknowledgmentstringRequired

Optional: Acknowledgment requirement - boolean true|false|1|0

fifth_reminder_at_t_minus_daysstringRequired

Optional: Fifth reminder offset - integer 0-365

first_reminder_at_t_minus_daysstringRequired

Optional: First reminder offset - integer 0-365

third_reminder_at_t_minus_daysstringRequired

Optional: Third reminder offset - integer 0-365

fourth_reminder_at_t_minus_daysstringRequired

Optional: Fourth reminder offset - integer 0-365

second_reminder_at_t_minus_daysstringRequired

Optional: Second reminder offset - integer 0-365

Response

Successful response