API ReferenceOrders
Append recipients to a specified order using its unique Order ID
Append recipients to a specified order using its unique Order ID
Append recipients to a specified order using its unique Order ID
Authorization
ApiKey X-API-KEY<token>
In: header
Path Parameters
id*integer
The Id of the order to add recipients to.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
recipients*array<>
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/order/0/recipients" \ -H "Content-Type: application/json" \ -d '{ "recipients": [ { "id": 0, "address": { "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "zip4": "string", "zip2": "string", "country": "string" }, "personal": { "firstName": "string", "lastName": "string", "toOrganization": "string", "salutation": "string" }, "metadata": { "dpvConfirmationCode": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "salutation": "string", "returnTitle": "string", "returnFirstName": "string", "returnLastName": "string", "returnOrganization": "string", "returnAddress1": "string", "returnAddress2": "string", "returnCity": "string", "returnZip": "string", "returnState": "string", "email": "string", "qrUrl": "string", "text": "string", "text2": "string", "radiusPinStreet": "string", "radiusPinAddress": "string", "fullAddress": "string", "deliveryStatus": "string" } } ] }'{ "payload": { "orderId": 0, "status": "string", "totalRecipients": 0, "deliverable": { "addressValidated": 0, "addressInvalidated": 0 }, "undeliverable": { "duplicated": 0, "doNotMail": 0, "invalidAddress": 0, "undeliverableRecipients": [ { "address": { "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "zip4": "string", "zip2": "string", "country": "string" }, "personal": { "firstName": "string", "lastName": "string", "toOrganization": "string", "salutation": "string" }, "metadata": { "dpvConfirmationCode": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "salutation": "string", "returnTitle": "string", "returnFirstName": "string", "returnLastName": "string", "returnOrganization": "string", "returnAddress1": "string", "returnAddress2": "string", "returnCity": "string", "returnZip": "string", "returnState": "string", "email": "string", "qrUrl": "string", "text": "string", "text2": "string", "radiusPinStreet": "string", "radiusPinAddress": "string", "fullAddress": "string", "deliveryStatus": "string" } } ] }, "variableImages": { "summary": { "accepted": 0, "aspectRatioMismatch": 0, "lowDpi": 0, "unsupportedOrBroken": 0, "missing": 0, "doesNotExist": 0 }, "recipientsWithIssues": [ { "recipientIndex": 0, "issues": [ { "field": "string", "code": "string", "message": "string" } ] } ] } }, "errors": [ "string" ], "errorDetails": [ null ], "warnings": [ "string" ], "hasErrors": true, "hasWarnings": true}{ "payload": { "orderId": 0, "status": "string", "totalRecipients": 0, "deliverable": { "addressValidated": 0, "addressInvalidated": 0 }, "undeliverable": { "duplicated": 0, "doNotMail": 0, "invalidAddress": 0, "undeliverableRecipients": [ { "address": { "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "zip4": "string", "zip2": "string", "country": "string" }, "personal": { "firstName": "string", "lastName": "string", "toOrganization": "string", "salutation": "string" }, "metadata": { "dpvConfirmationCode": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "salutation": "string", "returnTitle": "string", "returnFirstName": "string", "returnLastName": "string", "returnOrganization": "string", "returnAddress1": "string", "returnAddress2": "string", "returnCity": "string", "returnZip": "string", "returnState": "string", "email": "string", "qrUrl": "string", "text": "string", "text2": "string", "radiusPinStreet": "string", "radiusPinAddress": "string", "fullAddress": "string", "deliveryStatus": "string" } } ] }, "variableImages": { "summary": { "accepted": 0, "aspectRatioMismatch": 0, "lowDpi": 0, "unsupportedOrBroken": 0, "missing": 0, "doesNotExist": 0 }, "recipientsWithIssues": [ { "recipientIndex": 0, "issues": [ { "field": "string", "code": "string", "message": "string" } ] } ] } }, "errors": [ "string" ], "errorDetails": [ null ], "warnings": [ "string" ], "hasErrors": true, "hasWarnings": true}{ "payload": { "orderId": 0, "status": "string", "totalRecipients": 0, "deliverable": { "addressValidated": 0, "addressInvalidated": 0 }, "undeliverable": { "duplicated": 0, "doNotMail": 0, "invalidAddress": 0, "undeliverableRecipients": [ { "address": { "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "zip4": "string", "zip2": "string", "country": "string" }, "personal": { "firstName": "string", "lastName": "string", "toOrganization": "string", "salutation": "string" }, "metadata": { "dpvConfirmationCode": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "salutation": "string", "returnTitle": "string", "returnFirstName": "string", "returnLastName": "string", "returnOrganization": "string", "returnAddress1": "string", "returnAddress2": "string", "returnCity": "string", "returnZip": "string", "returnState": "string", "email": "string", "qrUrl": "string", "text": "string", "text2": "string", "radiusPinStreet": "string", "radiusPinAddress": "string", "fullAddress": "string", "deliveryStatus": "string" } } ] }, "variableImages": { "summary": { "accepted": 0, "aspectRatioMismatch": 0, "lowDpi": 0, "unsupportedOrBroken": 0, "missing": 0, "doesNotExist": 0 }, "recipientsWithIssues": [ { "recipientIndex": 0, "issues": [ { "field": "string", "code": "string", "message": "string" } ] } ] } }, "errors": [ "string" ], "errorDetails": [ null ], "warnings": [ "string" ], "hasErrors": true, "hasWarnings": true}{ "payload": { "orderId": 0, "status": "string", "totalRecipients": 0, "deliverable": { "addressValidated": 0, "addressInvalidated": 0 }, "undeliverable": { "duplicated": 0, "doNotMail": 0, "invalidAddress": 0, "undeliverableRecipients": [ { "address": { "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "zip4": "string", "zip2": "string", "country": "string" }, "personal": { "firstName": "string", "lastName": "string", "toOrganization": "string", "salutation": "string" }, "metadata": { "dpvConfirmationCode": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "salutation": "string", "returnTitle": "string", "returnFirstName": "string", "returnLastName": "string", "returnOrganization": "string", "returnAddress1": "string", "returnAddress2": "string", "returnCity": "string", "returnZip": "string", "returnState": "string", "email": "string", "qrUrl": "string", "text": "string", "text2": "string", "radiusPinStreet": "string", "radiusPinAddress": "string", "fullAddress": "string", "deliveryStatus": "string" } } ] }, "variableImages": { "summary": { "accepted": 0, "aspectRatioMismatch": 0, "lowDpi": 0, "unsupportedOrBroken": 0, "missing": 0, "doesNotExist": 0 }, "recipientsWithIssues": [ { "recipientIndex": 0, "issues": [ { "field": "string", "code": "string", "message": "string" } ] } ] } }, "errors": [ "string" ], "errorDetails": [ null ], "warnings": [ "string" ], "hasErrors": true, "hasWarnings": true}