Create Bulk Dispatch | propelone

This endpoint expects a multipart form.

expires_atstringRequired

Optional: Dispatch expiration - date format - must be in the future

document_idstringRequired

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

send_via_smsstringRequired

Optional: Enable SMS channel - boolean

send_via_emailstringRequired

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

send_via_portalstringRequired

Optional: Enable 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 - both-or-neither with parent_record_id

recipients[0][recipient_name]stringRequired

Required if recipient is external: Snapshot recipient name - max 255 chars

recipients[0][recipient_email]stringRequired

Optional per-recipient: Snapshot email - valid email - max 255 chars

recipients[0][recipient_phone]stringRequired

Optional per-recipient: Snapshot phone - max 32 chars

recipients[0][is_external_recipient]stringRequired

Optional per-recipient: External-recipient flag - boolean

recipients[0][recipient_customer_id]stringRequired

Optional per-recipient: CRM customer UUID - must belong to tenant

recipients[0][external_recipient_label]stringRequired

Required if recipient is external: Display label - max 255 chars

recipients[0][recipient_customer_contact_id]stringRequired

Optional per-recipient: CRM customer contact UUID

recipients[0][recipient_customer_location_id]stringRequired

Optional per-recipient: CRM customer location UUID

Successful response

1	curl -X POST https://https//https/documents/bulk-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-31" \
5	-F document_id="a3f1c9e2-4b7d-4f8a-9c2e-123456789abc" \
6	-F send_via_sms="true" \
7	-F send_via_email="true" \
8	-F send_via_portal="false" \
9	-F send_via_postal="false" \
10	-F parent_record_id="d4e5f6a7-b8c9-4d0e-9f1a-9876543210fe" \
11	-F parent_record_type="invoice" \
12	-F recipients[0][recipient_name]="Jane Doe" \
13	-F recipients[0][recipient_email]="jane.doe@example.com" \
14	-F recipients[0][recipient_phone]="+14155552671" \
15	-F recipients[0][is_external_recipient]="true" \
16	-F recipients[0][recipient_customer_id]="c1d2e3f4-5678-90ab-cdef-1234567890ab" \
17	-F recipients[0][external_recipient_label]="Primary Contact" \
18	-F recipients[0][recipient_customer_contact_id]="b2c3d4e5-f678-90ab-cdef-0987654321ba" \
19	-F recipients[0][recipient_customer_location_id]="a1b2c3d4-e5f6-7890-abcd-ef1234567890"