API ReferenceAutomations
Post a recipient into a integration order
Posts recipient in the specified integration order
Posts recipient in the specified integration order
Authorization
ApiKey X-API-KEY<token>
In: header
Path Parameters
id*integer
ID of integration order to add recipient to.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
id*integer
firstName*string|null
lastName*string|null
toOrganization*string|null
address1*string|null
address2*string|null
city*string|null
state*string|null
zipCode*string|null
country*string|null
custom1*string|null
custom2*string|null
custom3*string|null
custom4*string|null
custom5*string|null
custom6*string|null
image1*string|null
image2*string|null
image3*string|null
image4*string|null
image5*string|null
image6*string|null
salutation*string|null
birthDay*|
anniversary*|
returnTitle*string|null
returnFirstName*string|null
returnLastName*string|null
returnOrganization*string|null
returnAddress1*string|null
returnAddress2*string|null
returnCity*string|null
returnState*string|null
returnZip*string|null
qrUrl*string|null
email*string|null
fullAddress*string|null
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": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "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": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "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": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "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": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "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": "string", "integrationOrderStatus": "string" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}