> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Create Bulk Dispatch POST https://documents/bulk-dispatches Content-Type: multipart/form-data Reference: https://docs.itspropel.com/propel-biz/30-documents/bulk-dispatches/create-bulk-dispatch ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /documents/bulk-dispatches: post: operationId: create-bulk-dispatch summary: Create Bulk Dispatch tags: - subpackage_30Documents.subpackage_30Documents/bulkDispatches parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/30 Documents_Bulk Dispatches_Create Bulk Dispatch_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: expires_at: type: string description: >- Optional: Dispatch expiration - date format - must be in the future document_id: type: string description: >- Required: Document UUID - exists:documents,id - document MUST be PUBLISHED send_via_sms: type: string description: 'Optional: Enable SMS channel - boolean' send_via_email: type: string description: >- Optional: Enable email channel - boolean - at least one channel required send_via_portal: type: string description: 'Optional: Enable portal channel - boolean' send_via_postal: type: string description: 'Optional: Enable postal channel - boolean' parent_record_id: type: string description: >- Optional: Parent record UUID - both-or-neither with parent_record_type parent_record_type: type: string description: >- Optional: Polymorphic parent type - both-or-neither with parent_record_id recipients[0][recipient_name]: type: string description: >- Required if recipient is external: Snapshot recipient name - max 255 chars recipients[0][recipient_email]: type: string description: >- Optional per-recipient: Snapshot email - valid email - max 255 chars recipients[0][recipient_phone]: type: string description: 'Optional per-recipient: Snapshot phone - max 32 chars' recipients[0][is_external_recipient]: type: string description: 'Optional per-recipient: External-recipient flag - boolean' recipients[0][recipient_customer_id]: type: string description: >- Optional per-recipient: CRM customer UUID - must belong to tenant recipients[0][external_recipient_label]: type: string description: >- Required if recipient is external: Display label - max 255 chars recipients[0][recipient_customer_contact_id]: type: string description: 'Optional per-recipient: CRM customer contact UUID' recipients[0][recipient_customer_location_id]: type: string description: 'Optional per-recipient: CRM customer location UUID' required: - expires_at - document_id - send_via_sms - send_via_email - send_via_portal - send_via_postal - parent_record_id - parent_record_type - recipients[0][recipient_name] - recipients[0][recipient_email] - recipients[0][recipient_phone] - recipients[0][is_external_recipient] - recipients[0][recipient_customer_id] - recipients[0][external_recipient_label] - recipients[0][recipient_customer_contact_id] - recipients[0][recipient_customer_location_id] servers: - url: https:/ components: schemas: 30 Documents_Bulk Dispatches_Create Bulk Dispatch_Response_200: type: object properties: {} description: Empty response body title: 30 Documents_Bulk Dispatches_Create Bulk Dispatch_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/documents/bulk-dispatches" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expires_at\"\r\n\r\n2024-12-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_id\"\r\n\r\na3f1c9e2-4b7d-4f8a-9c2e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_sms\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_portal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_postal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-9876543210fe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\ninvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_name]\"\r\n\r\nJane Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_phone]\"\r\n\r\n+14155552671\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][is_external_recipient]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_id]\"\r\n\r\nc1d2e3f4-5678-90ab-cdef-1234567890ab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][external_recipient_label]\"\r\n\r\nPrimary Contact\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_contact_id]\"\r\n\r\nb2c3d4e5-f678-90ab-cdef-0987654321ba\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_location_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/documents/bulk-dispatches'; const form = new FormData(); form.append('expires_at', '2024-12-31'); form.append('document_id', 'a3f1c9e2-4b7d-4f8a-9c2e-123456789abc'); form.append('send_via_sms', 'true'); form.append('send_via_email', 'true'); form.append('send_via_portal', 'false'); form.append('send_via_postal', 'false'); form.append('parent_record_id', 'd4e5f6a7-b8c9-4d0e-9f1a-9876543210fe'); form.append('parent_record_type', 'invoice'); form.append('recipients[0][recipient_name]', 'Jane Doe'); form.append('recipients[0][recipient_email]', 'jane.doe@example.com'); form.append('recipients[0][recipient_phone]', '+14155552671'); form.append('recipients[0][is_external_recipient]', 'true'); form.append('recipients[0][recipient_customer_id]', 'c1d2e3f4-5678-90ab-cdef-1234567890ab'); form.append('recipients[0][external_recipient_label]', 'Primary Contact'); form.append('recipients[0][recipient_customer_contact_id]', 'b2c3d4e5-f678-90ab-cdef-0987654321ba'); form.append('recipients[0][recipient_customer_location_id]', 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/documents/bulk-dispatches" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expires_at\"\r\n\r\n2024-12-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_id\"\r\n\r\na3f1c9e2-4b7d-4f8a-9c2e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_sms\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_portal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_postal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-9876543210fe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\ninvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_name]\"\r\n\r\nJane Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_phone]\"\r\n\r\n+14155552671\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][is_external_recipient]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_id]\"\r\n\r\nc1d2e3f4-5678-90ab-cdef-1234567890ab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][external_recipient_label]\"\r\n\r\nPrimary Contact\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_contact_id]\"\r\n\r\nb2c3d4e5-f678-90ab-cdef-0987654321ba\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_location_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/documents/bulk-dispatches") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expires_at\"\r\n\r\n2024-12-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_id\"\r\n\r\na3f1c9e2-4b7d-4f8a-9c2e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_sms\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_portal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_postal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-9876543210fe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\ninvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_name]\"\r\n\r\nJane Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_phone]\"\r\n\r\n+14155552671\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][is_external_recipient]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_id]\"\r\n\r\nc1d2e3f4-5678-90ab-cdef-1234567890ab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][external_recipient_label]\"\r\n\r\nPrimary Contact\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_contact_id]\"\r\n\r\nb2c3d4e5-f678-90ab-cdef-0987654321ba\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_location_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/documents/bulk-dispatches") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expires_at\"\r\n\r\n2024-12-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_id\"\r\n\r\na3f1c9e2-4b7d-4f8a-9c2e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_sms\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_portal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_postal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-9876543210fe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\ninvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_name]\"\r\n\r\nJane Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_phone]\"\r\n\r\n+14155552671\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][is_external_recipient]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_id]\"\r\n\r\nc1d2e3f4-5678-90ab-cdef-1234567890ab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][external_recipient_label]\"\r\n\r\nPrimary Contact\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_contact_id]\"\r\n\r\nb2c3d4e5-f678-90ab-cdef-0987654321ba\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_location_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/documents/bulk-dispatches', [ 'multipart' => [ [ 'name' => 'expires_at', 'contents' => '2024-12-31' ], [ 'name' => 'document_id', 'contents' => 'a3f1c9e2-4b7d-4f8a-9c2e-123456789abc' ], [ 'name' => 'send_via_sms', 'contents' => 'true' ], [ 'name' => 'send_via_email', 'contents' => 'true' ], [ 'name' => 'send_via_portal', 'contents' => 'false' ], [ 'name' => 'send_via_postal', 'contents' => 'false' ], [ 'name' => 'parent_record_id', 'contents' => 'd4e5f6a7-b8c9-4d0e-9f1a-9876543210fe' ], [ 'name' => 'parent_record_type', 'contents' => 'invoice' ], [ 'name' => 'recipients[0][recipient_name]', 'contents' => 'Jane Doe' ], [ 'name' => 'recipients[0][recipient_email]', 'contents' => 'jane.doe@example.com' ], [ 'name' => 'recipients[0][recipient_phone]', 'contents' => '+14155552671' ], [ 'name' => 'recipients[0][is_external_recipient]', 'contents' => 'true' ], [ 'name' => 'recipients[0][recipient_customer_id]', 'contents' => 'c1d2e3f4-5678-90ab-cdef-1234567890ab' ], [ 'name' => 'recipients[0][external_recipient_label]', 'contents' => 'Primary Contact' ], [ 'name' => 'recipients[0][recipient_customer_contact_id]', 'contents' => 'b2c3d4e5-f678-90ab-cdef-0987654321ba' ], [ 'name' => 'recipients[0][recipient_customer_location_id]', 'contents' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/documents/bulk-dispatches"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"expires_at\"\r\n\r\n2024-12-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_id\"\r\n\r\na3f1c9e2-4b7d-4f8a-9c2e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_sms\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_email\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_portal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"send_via_postal\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-9876543210fe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\ninvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_name]\"\r\n\r\nJane Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_email]\"\r\n\r\njane.doe@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_phone]\"\r\n\r\n+14155552671\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][is_external_recipient]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_id]\"\r\n\r\nc1d2e3f4-5678-90ab-cdef-1234567890ab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][external_recipient_label]\"\r\n\r\nPrimary Contact\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_contact_id]\"\r\n\r\nb2c3d4e5-f678-90ab-cdef-0987654321ba\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][recipient_customer_location_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": "expires_at", "value": "2024-12-31" ], [ "name": "document_id", "value": "a3f1c9e2-4b7d-4f8a-9c2e-123456789abc" ], [ "name": "send_via_sms", "value": "true" ], [ "name": "send_via_email", "value": "true" ], [ "name": "send_via_portal", "value": "false" ], [ "name": "send_via_postal", "value": "false" ], [ "name": "parent_record_id", "value": "d4e5f6a7-b8c9-4d0e-9f1a-9876543210fe" ], [ "name": "parent_record_type", "value": "invoice" ], [ "name": "recipients[0][recipient_name]", "value": "Jane Doe" ], [ "name": "recipients[0][recipient_email]", "value": "jane.doe@example.com" ], [ "name": "recipients[0][recipient_phone]", "value": "+14155552671" ], [ "name": "recipients[0][is_external_recipient]", "value": "true" ], [ "name": "recipients[0][recipient_customer_id]", "value": "c1d2e3f4-5678-90ab-cdef-1234567890ab" ], [ "name": "recipients[0][external_recipient_label]", "value": "Primary Contact" ], [ "name": "recipients[0][recipient_customer_contact_id]", "value": "b2c3d4e5-f678-90ab-cdef-0987654321ba" ], [ "name": "recipients[0][recipient_customer_location_id]", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/documents/bulk-dispatches")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```