Create Document

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
namestringRequired

Required: Document name - max 255 chars

body_htmlstringRequired

Required if authoring_mode=COMPOSED: HTML body of the composed document - string

descriptionstringRequired

Optional: Long-form description - max 5000 chars

template_idstringRequired

Required if authoring_mode=TEMPLATED: UUID of the source template - exists:templates,id

effective_tostringRequired

Optional: Effective-to date - date format - must be after_or_equal effective_from

authoring_modestringRequired

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

effective_fromstringRequired

Optional: Effective-from date for this document version - date format

document_type_idstringRequired

Required: Document type UUID - exists:document_types,id (UUID converted to int by ConvertUuidToId middleware)

requires_signaturestringRequired

Optional: Document requires recipient signature(s) - boolean true|false|1|0

default_expiry_daysstringRequired

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

expected_signer_rolestringRequired

Optional: Expected role of primary signer - in: CUSTOMER|TENANT|PROPERTY_MANAGER|AUTHORIZED_REPRESENTATIVE|TECHNICIAN|SUBCONTRACTOR|INSPECTOR|SUPERVISOR|COMPANY_REPRESENTATIVE|WITNESS|OTHER - max 64 chars

source_attachment_idstringRequired

Required if authoring_mode=UPLOADED: UUID of the source PDF attachment - exists:attachments,id

requires_acknowledgmentstringRequired

Optional: Document requires recipient acknowledgment - boolean true|false|1|0

fifth_reminder_at_t_minus_daysstringRequired

Optional: Fifth reminder days before expiry - integer 0-365

first_reminder_at_t_minus_daysstringRequired

Optional: First reminder days before expiry - integer 0-365

third_reminder_at_t_minus_daysstringRequired

Optional: Third reminder days before expiry - integer 0-365

fourth_reminder_at_t_minus_daysstringRequired

Optional: Fourth reminder days before expiry - integer 0-365

second_reminder_at_t_minus_daysstringRequired

Optional: Second reminder days before expiry - integer 0-365

Response

Successful response