Create Dispatch | propelone

This endpoint expects a multipart form.

expires_atstringRequired

Optional: Dispatch expiration timestamp - date format - must be in the future - falls back to default_dispatch_expiry_days when omitted

document_idstringRequired

Required: Document UUID - exists:documents,id - document MUST be PUBLISHED

send_via_smsstringRequired

Optional: Enable SMS channel - boolean - tenant settings must allow

recipient_namestringRequired

Required if is_external_recipient=true: Recipient name snapshot - max 255 chars

send_via_emailstringRequired

Optional: Enable email channel - boolean - at least one channel required

recipient_emailstringRequired

Optional: Recipient email snapshot - valid email - max 255 chars

recipient_phonestringRequired

Optional: Recipient phone snapshot - max 32 chars

send_via_portalstringRequired

Optional: Enable customer portal channel - boolean

send_via_postalstringRequired

Optional: Enable postal channel - boolean

parent_record_idstringRequired

Optional: Parent record UUID - both-or-neither with parent_record_type

parent_record_typestringRequired

Optional: Polymorphic parent type - registered morph alias - both-or-neither with parent_record_id

is_external_recipientstringRequired

Optional: Recipient is non-CRM external (snapshot only) - boolean - requires allow_external_recipients=true

recipient_customer_idstringRequired

Optional: CRM customer UUID - exists:customers,id - must belong to current tenant

external_recipient_labelstringRequired

Required if is_external_recipient=true: Display label for the external recipient - max 255 chars

recipient_customer_contact_idstringRequired

Optional: CRM customer contact UUID - exists:customer_contacts,id - must belong to current tenant

recipient_customer_location_idstringRequired

Optional: CRM customer location UUID - exists:customer_locations,id - must belong to current tenant

Successful response

1	curl -X POST https://https//https/documents/dispatches \
2	-H "{{tenant_key_name}}: {{tenant_key_value1}}\|{{tenant_key_value2}}" \
3	-H "Content-Type: multipart/form-data" \
4	-F expires_at="2024-12-31T23:59:59Z" \
5	-F document_id="a3f1c9e2-4b7d-4f8a-9c2e-123456789abc" \
6	-F send_via_sms="true" \
7	-F recipient_name="Jane Doe" \
8	-F send_via_email="true" \
9	-F recipient_email="jane.doe@example.com" \
10	-F recipient_phone="+14155552671" \
11	-F send_via_portal="false" \
12	-F send_via_postal="false" \
13	-F parent_record_id="d9b2d63d-a233-4123-847a-7a3a1f9b8f1e" \
14	-F parent_record_type="invoice" \
15	-F is_external_recipient="true" \
16	-F recipient_customer_id="c1a2b3d4-e5f6-7890-abcd-ef1234567890" \
17	-F external_recipient_label="External Partner" \
18	-F recipient_customer_contact_id="f4e5d6c7-b8a9-0123-4567-89abcdef0123" \
19	-F recipient_customer_location_id="a1b2c3d4-e5f6-7890-abcd-ef0987654321"