# Add Recipient

Add a recipient into a integration order by Id. If the integration order is Active, recipient will be added to queue to be mailed to.

Endpoint: POST /v1/integration-orders/{id}/recipients
Version: 1.0.0
Security: apikey

## Path parameters:

  - `id` (integer, required)
    ID of integration order to add recipient to.

## Request fields (application/json):

  - `id` (integer)
    Order Recipient ID

  - `firstName` (string)
    Order Recipient First Name

  - `lastName` (string)
    Order Recipient Last Name

  - `toOrganization` (string)
    Order Recipient Organization

  - `address1` (string)
    Order Recipient Address Line 1

  - `address2` (string)
    Order Recipient Address Line 2

  - `city` (string)
    Order Recipient City

  - `state` (string)
    Order Recipient State

  - `zipCode` (string)
    Order Recipient Zip Code

  - `country` (string)
    Order Recipient Country

  - `custom1` (string)
    Order Recipient Custom Field 1 for Mail-Merge.

  - `custom2` (string)
    Recipient Custom Field 2 for Mail-Merge.

  - `custom3` (string)
    Recipient Custom Field 3 for Mail-Merge.

  - `custom4` (string)
    Recipient Custom Field 4 for Mail-Merge.

  - `custom5` (string)
    Recipient Custom Field 5 for Mail-Merge.

  - `custom6` (string)
    Recipient Custom Field 6 for Mail-Merge.

  - `salutation` (string)
    Recipient Salutation

  - `birthDay` (string)
    Recipient Birthday

  - `anniversary` (string)
    Recipient Anniversary

  - `returnTitle` (string)
    Return Address Title

  - `returnFirstName` (string)
    Mailpiece Return Address First Name. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

  - `returnLastName` (string)
    Mailpiece Return Address Last Name. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

  - `returnOrganization` (string)
    Mailpiece Return Address Organization. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

  - `returnAddress1` (string)
    Mailpiece Return Address Line 1. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

  - `returnAddress2` (string)
    Mailpiece Return Address Line 2. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

  - `returnCity` (string)
    Mailpiece Return Address City. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

  - `returnState` (string)
    Mailpiece Return Address State. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

  - `returnZip` (string)
    Mailpiece Return Address Zip Code. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

  - `qrUrl` (string)
    Mailpiece QR Code URL. Use this to override the template's QR code and provide a unique QR URL per recipient.

  - `fullAddress` (string)
    Recipient Full Address (Optional)

## Response 200 fields (application/json):

  - `profile` (object)

  - `profile.id` (integer)
    Account ID

  - `profile.aadId` (string)
    Account AAD ID

  - `profile.email` (string)
    Account Email

  - `profile.firstName` (string)
    Account First Name

  - `profile.lastName` (string)
    Account Last Name

  - `profile.company` (string)
    Account Company

  - `profile.created` (string)
    Account Created Date

  - `profile.shouldProcessQrCodes` (boolean)
    Account Setting - Should Process QR Codes

  - `payload` (object)

  - `payload.id` (integer)
    Integration Order ID

  - `payload.name` (string)
    Integration Order Name

  - `payload.createdDate` (string)
    Integration Order Created Date

  - `payload.updatedDate` (string)
    Integration Order Updated Date

  - `payload.postageType` (string)
    Integration Order Postage Type. FirstClass or Standard.

  - `payload.integrationOrderStatus` (string)
    Integration Order Status. Pending, In Progress, Completed, Failed, Cancelled.

  - `errors` (array)

  - `hasErrors` (boolean)

  - `warnings` (array)

  - `hasWarnings` (boolean)

  - `metadata` (object)

## Response 400 fields (application/json):

  - `profile` (object)

  - `profile.id` (integer)
    Account ID

  - `profile.aadId` (string)
    Account AAD ID

  - `profile.email` (string)
    Account Email

  - `profile.firstName` (string)
    Account First Name

  - `profile.lastName` (string)
    Account Last Name

  - `profile.company` (string)
    Account Company

  - `profile.created` (string)
    Account Created Date

  - `profile.shouldProcessQrCodes` (boolean)
    Account Setting - Should Process QR Codes

  - `payload` (object)

  - `payload.id` (integer)
    Integration Order ID

  - `payload.name` (string)
    Integration Order Name

  - `payload.createdDate` (string)
    Integration Order Created Date

  - `payload.updatedDate` (string)
    Integration Order Updated Date

  - `payload.postageType` (string)
    Integration Order Postage Type. FirstClass or Standard.

  - `payload.integrationOrderStatus` (string)
    Integration Order Status. Pending, In Progress, Completed, Failed, Cancelled.

  - `errors` (array)

  - `hasErrors` (boolean)

  - `warnings` (array)

  - `hasWarnings` (boolean)

  - `metadata` (object)

## Response 401 fields (application/json):

  - `profile` (object)

  - `profile.id` (integer)
    Account ID

  - `profile.aadId` (string)
    Account AAD ID

  - `profile.email` (string)
    Account Email

  - `profile.firstName` (string)
    Account First Name

  - `profile.lastName` (string)
    Account Last Name

  - `profile.company` (string)
    Account Company

  - `profile.created` (string)
    Account Created Date

  - `profile.shouldProcessQrCodes` (boolean)
    Account Setting - Should Process QR Codes

  - `payload` (object)

  - `payload.id` (integer)
    Integration Order ID

  - `payload.name` (string)
    Integration Order Name

  - `payload.createdDate` (string)
    Integration Order Created Date

  - `payload.updatedDate` (string)
    Integration Order Updated Date

  - `payload.postageType` (string)
    Integration Order Postage Type. FirstClass or Standard.

  - `payload.integrationOrderStatus` (string)
    Integration Order Status. Pending, In Progress, Completed, Failed, Cancelled.

  - `errors` (array)

  - `hasErrors` (boolean)

  - `warnings` (array)

  - `hasWarnings` (boolean)

  - `metadata` (object)

## Response 422 fields (application/json):

  - `profile` (object)

  - `profile.id` (integer)
    Account ID

  - `profile.aadId` (string)
    Account AAD ID

  - `profile.email` (string)
    Account Email

  - `profile.firstName` (string)
    Account First Name

  - `profile.lastName` (string)
    Account Last Name

  - `profile.company` (string)
    Account Company

  - `profile.created` (string)
    Account Created Date

  - `profile.shouldProcessQrCodes` (boolean)
    Account Setting - Should Process QR Codes

  - `payload` (object)

  - `payload.id` (integer)
    Integration Order ID

  - `payload.name` (string)
    Integration Order Name

  - `payload.createdDate` (string)
    Integration Order Created Date

  - `payload.updatedDate` (string)
    Integration Order Updated Date

  - `payload.postageType` (string)
    Integration Order Postage Type. FirstClass or Standard.

  - `payload.integrationOrderStatus` (string)
    Integration Order Status. Pending, In Progress, Completed, Failed, Cancelled.

  - `errors` (array)

  - `hasErrors` (boolean)

  - `warnings` (array)

  - `hasWarnings` (boolean)

  - `metadata` (object)