Add a recipient to an integration order
Adds one recipient to an integration order, validating and standardizing the address before queueing the mail piece for that recipient.
Adds one recipient to an integration order, validating and standardizing the address before queueing the mail piece for that recipient.
Authorization
ApiKey In: header
Path Parameters
ID of integration order to add recipient to.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Represents an integration order recipient.
Gets or sets the ID of the recipient.
Gets or sets the first name of the recipient.
Gets or sets the last name of the recipient.
Gets or sets the organization of the recipient.
Gets or sets the address line 1 of the recipient.
Gets or sets the address line 2 of the recipient.
Gets or sets the city of the recipient.
Gets or sets the state of the recipient.
Gets or sets the zip code of the recipient.
Gets or sets the country of the recipient.
Gets or sets the custom field 1 of the recipient.
Gets or sets the custom field 2 of the recipient.
Gets or sets the custom field 3 of the recipient.
Gets or sets the custom field 4 of the recipient.
Gets or sets the custom field 5 of the recipient.
Gets or sets the custom field 6 of the recipient.
Gets or sets the public image URL for variable image (Mail-Merge Image) slot 1. Resolved per recipient at send time; falls back to the template default when blank/invalid.
Gets or sets the public image URL for variable image (Mail-Merge Image) slot 2. Resolved per recipient at send time; falls back to the template default when blank/invalid.
Gets or sets the public image URL for variable image (Mail-Merge Image) slot 3. Resolved per recipient at send time; falls back to the template default when blank/invalid.
Gets or sets the public image URL for variable image (Mail-Merge Image) slot 4. Resolved per recipient at send time; falls back to the template default when blank/invalid.
Gets or sets the public image URL for variable image (Mail-Merge Image) slot 5. Resolved per recipient at send time; falls back to the template default when blank/invalid.
Gets or sets the public image URL for variable image (Mail-Merge Image) slot 6. Resolved per recipient at send time; falls back to the template default when blank/invalid.
Gets or sets the salutation of the recipient.
Gets or sets the birthday of the recipient.
Gets or sets the anniversary of the recipient.
Gets or sets the return title of the recipient.
Gets or sets the return first name of the recipient.
Gets or sets the return last name of the recipient.
Gets or sets the return organization of the recipient.
Gets or sets the return address line 1 of the recipient.
Gets or sets the return address line 2 of the recipient.
Gets or sets the return city of the recipient.
Gets or sets the return state of the recipient.
Gets or sets the return zip code of the recipient.
Gets or sets the QR code URL of the recipient.
Gets or sets the email address of the recipient.
Gets or sets the full address of the recipient.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/integration-orders/0/recipients" \ -H "Content-Type: application/json" \ -d '{ "id": 0, "firstName": "string", "lastName": "string", "toOrganization": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "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", "birthDay": "2019-08-24T14:15:22Z", "anniversary": "2019-08-24T14:15:22Z", "returnTitle": "string", "returnFirstName": "string", "returnLastName": "string", "returnOrganization": "string", "returnAddress1": "string", "returnAddress2": "string", "returnCity": "string", "returnState": "string", "returnZip": "string", "qrUrl": "string", "email": "string", "fullAddress": "string" }'{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "id": 0, "name": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "postageType": "Standard", "integrationOrderStatus": "Active" }, "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "id": 0, "name": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "postageType": "Standard", "integrationOrderStatus": "Active" }, "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "id": 0, "name": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "postageType": "Standard", "integrationOrderStatus": "Active" }, "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "success": true, "errorMessage": "string", "reasonCode": "RETURN_ADDRESS_PARTIAL", "integrationOrderId": 0, "recipientDetails": { "firstName": "string", "lastName": "string", "processedAddress": "string", "addressValidated": true } }, "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "id": 0, "name": "string", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "postageType": "Standard", "integrationOrderStatus": "Active" }, "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}Request a proximity mailing POST
Finds addresses around a point or address using the supplied filters and queues them as recipients on the integration order. Recipient discovery runs asynchronously after the request is accepted.
Record a QR code scan POST
Records a QR code scan event against an order recipient, updating that recipient's engagement statistics. Processing is asynchronous — the scan is queued and applied shortly after the request succeeds.