# Add Recipients Add recipients to a specified order in draft or edits needed status. Recipients will run through address validation, and the response will return how many are valid. Any recipients that have incomplete addresses will not be added to the order. Define mail-merge, image-merge, return address override, and other metadata at the recipient level. Endpoint: PUT /v1/order/{id}/recipients:append Version: 1.0.0 Security: apikey ## Query parameters: - `Id` (integer, required) The Id of the order to add recipients to. ## Request fields (application/json): - `recipients` (array, required) Array of recipient Ids to add to order. - `recipients.id` (integer) - `recipients.address` (object,null) Recipient Mailing Address. Where the piece will be mailed to. - `recipients.address.address1` (string,null) Recipient Address 1. - `recipients.address.address2` (string,null) Recipient Address 2. - `recipients.address.city` (string,null) Recipient City. - `recipients.address.state` (string,null) Recipient State. - `recipients.address.zipCode` (string,null) Recipient Zip Code. - `recipients.address.zip4` (string,null) Recipient Zip+4. - `recipients.address.zip2` (string,null) Recipient Delivery Point. - `recipients.address.country` (string,null) Recipient Country (Optional, US only). - `recipients.personal` (object,null) Recipient Personal Information - `recipients.personal.firstName` (string,null) Recipient First Name. - `recipients.personal.lastName` (string,null) Recipient Last Name. - `recipients.personal.toOrganization` (string,null) Recipient Organization. - `recipients.personal.salutation` (string) Recipient Salutation (used for Mail-Merge only). - `recipients.metadata` (object,null) Recipient Metadata. This is used for Mail-Merge and Image-merge fields to personalize the mailing to the individual. - `recipients.metadata.dpvConfirmationCode` (string) USPS Delivery Point Verification confirmation code. - `recipients.metadata.custom1` (string) Mail-Merge Field: {{Custom 1}} - `recipients.metadata.custom2` (string) Mail-Merge Field: {{Custom 2}} - `recipients.metadata.custom3` (string) Mail-Merge Field: {{Custom 3}} - `recipients.metadata.custom4` (string) Mail-Merge Field: {{Custom 4}} - `recipients.metadata.custom5` (string) Mail-Merge Field: {{Custom 5}} - `recipients.metadata.custom6` (string) Mail-Merge Field: {{Custom 6}} - `recipients.metadata.image1` (string) Image-Merge Field: URL to Image 1 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `recipients.metadata.image2` (string) Image-Merge Field: URL to Image 2 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `recipients.metadata.image3` (string) Image-Merge Field: URL to Image 3 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `recipients.metadata.image4` (string) Image-Merge Field: URL to Image 4 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `recipients.metadata.image5` (string) Image-Merge Field: URL to Image 5 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `recipients.metadata.image6` (string) Image-Merge Field: URL to Image 6 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `recipients.metadata.salutation` (string) Mail-Merge Field: {{Salutation}} - `recipients.metadata.returnTitle` (string) Return Address Override: Return Title. This overrides the return address fields set in the design template. - `recipients.metadata.returnFirstName` (string) Return Address Override: Return First Name. This overrides the return address fields set in the design template. - `recipients.metadata.returnLastName` (string) Return Address Override: Return Last Name. This overrides the return address fields set in the design template. - `recipients.metadata.returnOrganization` (string) Return Address Override: Return Organization Name. This overrides the return address fields set in the design template. - `recipients.metadata.returnAddress1` (string) Return Address Override: Return Address 1. This overrides the return address fields set in the design template. - `recipients.metadata.returnAddress2` (string) Return Address Override: Return Address 2. This overrides the return address fields set in the design template. - `recipients.metadata.returnCity` (string) Return Address Override: Return City. This overrides the return address fields set in the design template. - `recipients.metadata.returnZip` (string) Return Address Override: Return Zip. This overrides the return address fields set in the design template. - `recipients.metadata.returnState` (string) Return Address Override: Return State. This overrides the return address fields set in the design template. - `recipients.metadata.email` (string) Mail-Merge Field: {{Email}} - `recipients.metadata.qrUrl` (string) QR URL Override: Providing a QR URL for a recipient overrides the QR URL in the design template. A QR must exist in the design template to provide this field. - `recipients.metadata.text` (string) Handwritten Text: Returns the handwritten text on the design template (if product is handwritten). - `recipients.metadata.text2` (string) Bifold Secondary Handwritten Text: Returns the handwritten text on the bottom panel of the bifold card in design template (if product is Bifold). - `recipients.metadata.radiusPinStreet` (string) Radius Mail: Returns the Radius Pin Street. - `recipients.metadata.radiusPinAddress` (string) Radius Mail: Returns the Radius Pin Address. - `recipients.metadata.fullAddress` (string) Full Address Field: If the full address is provided as single string, the address will be decomposed post-validation into the send address fields. Provide either the FullAddress, or the decomposed fields above (e.g. Address 1, City, State, etc.), both not both. ## 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.totalRecipients` (integer) - `payload.deliverable` (object) - `payload.deliverable.addressValidated` (integer) - `payload.deliverable.addressInvalidated` (integer) - `payload.undeliverable` (object) - `payload.undeliverable.duplicated` (integer) - `payload.undeliverable.doNotMail` (integer) - `payload.undeliverable.invalidAddress` (integer) - `payload.undeliverable.undeliverableRecipients` (array) - `payload.undeliverable.undeliverableRecipients.address` (object,null) Recipient Mailing Address. Where the piece will be mailed to. - `payload.undeliverable.undeliverableRecipients.address.address1` (string,null) Recipient Address 1. - `payload.undeliverable.undeliverableRecipients.address.address2` (string,null) Recipient Address 2. - `payload.undeliverable.undeliverableRecipients.address.city` (string,null) Recipient City. - `payload.undeliverable.undeliverableRecipients.address.state` (string,null) Recipient State. - `payload.undeliverable.undeliverableRecipients.address.zipCode` (string,null) Recipient Zip Code. - `payload.undeliverable.undeliverableRecipients.address.zip4` (string,null) Recipient Zip+4. - `payload.undeliverable.undeliverableRecipients.address.zip2` (string,null) Recipient Delivery Point. - `payload.undeliverable.undeliverableRecipients.address.country` (string,null) Recipient Country (Optional, US only). - `payload.undeliverable.undeliverableRecipients.personal` (object,null) Recipient Personal Information - `payload.undeliverable.undeliverableRecipients.personal.firstName` (string,null) Recipient First Name. - `payload.undeliverable.undeliverableRecipients.personal.lastName` (string,null) Recipient Last Name. - `payload.undeliverable.undeliverableRecipients.personal.toOrganization` (string,null) Recipient Organization. - `payload.undeliverable.undeliverableRecipients.personal.salutation` (string) Recipient Salutation (used for Mail-Merge only). - `payload.undeliverable.undeliverableRecipients.metadata` (object,null) Recipient Metadata. This is used for Mail-Merge and Image-merge fields to personalize the mailing to the individual. - `payload.undeliverable.undeliverableRecipients.metadata.dpvConfirmationCode` (string) USPS Delivery Point Verification confirmation code. - `payload.undeliverable.undeliverableRecipients.metadata.custom1` (string) Mail-Merge Field: {{Custom 1}} - `payload.undeliverable.undeliverableRecipients.metadata.custom2` (string) Mail-Merge Field: {{Custom 2}} - `payload.undeliverable.undeliverableRecipients.metadata.custom3` (string) Mail-Merge Field: {{Custom 3}} - `payload.undeliverable.undeliverableRecipients.metadata.custom4` (string) Mail-Merge Field: {{Custom 4}} - `payload.undeliverable.undeliverableRecipients.metadata.custom5` (string) Mail-Merge Field: {{Custom 5}} - `payload.undeliverable.undeliverableRecipients.metadata.custom6` (string) Mail-Merge Field: {{Custom 6}} - `payload.undeliverable.undeliverableRecipients.metadata.image1` (string) Image-Merge Field: URL to Image 1 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image2` (string) Image-Merge Field: URL to Image 2 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image3` (string) Image-Merge Field: URL to Image 3 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image4` (string) Image-Merge Field: URL to Image 4 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image5` (string) Image-Merge Field: URL to Image 5 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image6` (string) Image-Merge Field: URL to Image 6 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.salutation` (string) Mail-Merge Field: {{Salutation}} - `payload.undeliverable.undeliverableRecipients.metadata.returnTitle` (string) Return Address Override: Return Title. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnFirstName` (string) Return Address Override: Return First Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnLastName` (string) Return Address Override: Return Last Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnOrganization` (string) Return Address Override: Return Organization Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnAddress1` (string) Return Address Override: Return Address 1. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnAddress2` (string) Return Address Override: Return Address 2. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnCity` (string) Return Address Override: Return City. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnZip` (string) Return Address Override: Return Zip. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnState` (string) Return Address Override: Return State. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.email` (string) Mail-Merge Field: {{Email}} - `payload.undeliverable.undeliverableRecipients.metadata.qrUrl` (string) QR URL Override: Providing a QR URL for a recipient overrides the QR URL in the design template. A QR must exist in the design template to provide this field. - `payload.undeliverable.undeliverableRecipients.metadata.text` (string) Handwritten Text: Returns the handwritten text on the design template (if product is handwritten). - `payload.undeliverable.undeliverableRecipients.metadata.text2` (string) Bifold Secondary Handwritten Text: Returns the handwritten text on the bottom panel of the bifold card in design template (if product is Bifold). - `payload.undeliverable.undeliverableRecipients.metadata.radiusPinStreet` (string) Radius Mail: Returns the Radius Pin Street. - `payload.undeliverable.undeliverableRecipients.metadata.radiusPinAddress` (string) Radius Mail: Returns the Radius Pin Address. - `payload.undeliverable.undeliverableRecipients.metadata.fullAddress` (string) Full Address Field: If the full address is provided as single string, the address will be decomposed post-validation into the send address fields. Provide either the FullAddress, or the decomposed fields above (e.g. Address 1, City, State, etc.), both not both. - `payload.orderId` (integer) - `payload.status` (string) - `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.totalRecipients` (integer) - `payload.deliverable` (object) - `payload.deliverable.addressValidated` (integer) - `payload.deliverable.addressInvalidated` (integer) - `payload.undeliverable` (object) - `payload.undeliverable.duplicated` (integer) - `payload.undeliverable.doNotMail` (integer) - `payload.undeliverable.invalidAddress` (integer) - `payload.undeliverable.undeliverableRecipients` (array) - `payload.undeliverable.undeliverableRecipients.address` (object,null) Recipient Mailing Address. Where the piece will be mailed to. - `payload.undeliverable.undeliverableRecipients.address.address1` (string,null) Recipient Address 1. - `payload.undeliverable.undeliverableRecipients.address.address2` (string,null) Recipient Address 2. - `payload.undeliverable.undeliverableRecipients.address.city` (string,null) Recipient City. - `payload.undeliverable.undeliverableRecipients.address.state` (string,null) Recipient State. - `payload.undeliverable.undeliverableRecipients.address.zipCode` (string,null) Recipient Zip Code. - `payload.undeliverable.undeliverableRecipients.address.zip4` (string,null) Recipient Zip+4. - `payload.undeliverable.undeliverableRecipients.address.zip2` (string,null) Recipient Delivery Point. - `payload.undeliverable.undeliverableRecipients.address.country` (string,null) Recipient Country (Optional, US only). - `payload.undeliverable.undeliverableRecipients.personal` (object,null) Recipient Personal Information - `payload.undeliverable.undeliverableRecipients.personal.firstName` (string,null) Recipient First Name. - `payload.undeliverable.undeliverableRecipients.personal.lastName` (string,null) Recipient Last Name. - `payload.undeliverable.undeliverableRecipients.personal.toOrganization` (string,null) Recipient Organization. - `payload.undeliverable.undeliverableRecipients.personal.salutation` (string) Recipient Salutation (used for Mail-Merge only). - `payload.undeliverable.undeliverableRecipients.metadata` (object,null) Recipient Metadata. This is used for Mail-Merge and Image-merge fields to personalize the mailing to the individual. - `payload.undeliverable.undeliverableRecipients.metadata.dpvConfirmationCode` (string) USPS Delivery Point Verification confirmation code. - `payload.undeliverable.undeliverableRecipients.metadata.custom1` (string) Mail-Merge Field: {{Custom 1}} - `payload.undeliverable.undeliverableRecipients.metadata.custom2` (string) Mail-Merge Field: {{Custom 2}} - `payload.undeliverable.undeliverableRecipients.metadata.custom3` (string) Mail-Merge Field: {{Custom 3}} - `payload.undeliverable.undeliverableRecipients.metadata.custom4` (string) Mail-Merge Field: {{Custom 4}} - `payload.undeliverable.undeliverableRecipients.metadata.custom5` (string) Mail-Merge Field: {{Custom 5}} - `payload.undeliverable.undeliverableRecipients.metadata.custom6` (string) Mail-Merge Field: {{Custom 6}} - `payload.undeliverable.undeliverableRecipients.metadata.image1` (string) Image-Merge Field: URL to Image 1 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image2` (string) Image-Merge Field: URL to Image 2 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image3` (string) Image-Merge Field: URL to Image 3 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image4` (string) Image-Merge Field: URL to Image 4 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image5` (string) Image-Merge Field: URL to Image 5 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image6` (string) Image-Merge Field: URL to Image 6 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.salutation` (string) Mail-Merge Field: {{Salutation}} - `payload.undeliverable.undeliverableRecipients.metadata.returnTitle` (string) Return Address Override: Return Title. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnFirstName` (string) Return Address Override: Return First Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnLastName` (string) Return Address Override: Return Last Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnOrganization` (string) Return Address Override: Return Organization Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnAddress1` (string) Return Address Override: Return Address 1. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnAddress2` (string) Return Address Override: Return Address 2. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnCity` (string) Return Address Override: Return City. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnZip` (string) Return Address Override: Return Zip. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnState` (string) Return Address Override: Return State. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.email` (string) Mail-Merge Field: {{Email}} - `payload.undeliverable.undeliverableRecipients.metadata.qrUrl` (string) QR URL Override: Providing a QR URL for a recipient overrides the QR URL in the design template. A QR must exist in the design template to provide this field. - `payload.undeliverable.undeliverableRecipients.metadata.text` (string) Handwritten Text: Returns the handwritten text on the design template (if product is handwritten). - `payload.undeliverable.undeliverableRecipients.metadata.text2` (string) Bifold Secondary Handwritten Text: Returns the handwritten text on the bottom panel of the bifold card in design template (if product is Bifold). - `payload.undeliverable.undeliverableRecipients.metadata.radiusPinStreet` (string) Radius Mail: Returns the Radius Pin Street. - `payload.undeliverable.undeliverableRecipients.metadata.radiusPinAddress` (string) Radius Mail: Returns the Radius Pin Address. - `payload.undeliverable.undeliverableRecipients.metadata.fullAddress` (string) Full Address Field: If the full address is provided as single string, the address will be decomposed post-validation into the send address fields. Provide either the FullAddress, or the decomposed fields above (e.g. Address 1, City, State, etc.), both not both. - `payload.orderId` (integer) - `payload.status` (string) - `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.totalRecipients` (integer) - `payload.deliverable` (object) - `payload.deliverable.addressValidated` (integer) - `payload.deliverable.addressInvalidated` (integer) - `payload.undeliverable` (object) - `payload.undeliverable.duplicated` (integer) - `payload.undeliverable.doNotMail` (integer) - `payload.undeliverable.invalidAddress` (integer) - `payload.undeliverable.undeliverableRecipients` (array) - `payload.undeliverable.undeliverableRecipients.address` (object,null) Recipient Mailing Address. Where the piece will be mailed to. - `payload.undeliverable.undeliverableRecipients.address.address1` (string,null) Recipient Address 1. - `payload.undeliverable.undeliverableRecipients.address.address2` (string,null) Recipient Address 2. - `payload.undeliverable.undeliverableRecipients.address.city` (string,null) Recipient City. - `payload.undeliverable.undeliverableRecipients.address.state` (string,null) Recipient State. - `payload.undeliverable.undeliverableRecipients.address.zipCode` (string,null) Recipient Zip Code. - `payload.undeliverable.undeliverableRecipients.address.zip4` (string,null) Recipient Zip+4. - `payload.undeliverable.undeliverableRecipients.address.zip2` (string,null) Recipient Delivery Point. - `payload.undeliverable.undeliverableRecipients.address.country` (string,null) Recipient Country (Optional, US only). - `payload.undeliverable.undeliverableRecipients.personal` (object,null) Recipient Personal Information - `payload.undeliverable.undeliverableRecipients.personal.firstName` (string,null) Recipient First Name. - `payload.undeliverable.undeliverableRecipients.personal.lastName` (string,null) Recipient Last Name. - `payload.undeliverable.undeliverableRecipients.personal.toOrganization` (string,null) Recipient Organization. - `payload.undeliverable.undeliverableRecipients.personal.salutation` (string) Recipient Salutation (used for Mail-Merge only). - `payload.undeliverable.undeliverableRecipients.metadata` (object,null) Recipient Metadata. This is used for Mail-Merge and Image-merge fields to personalize the mailing to the individual. - `payload.undeliverable.undeliverableRecipients.metadata.dpvConfirmationCode` (string) USPS Delivery Point Verification confirmation code. - `payload.undeliverable.undeliverableRecipients.metadata.custom1` (string) Mail-Merge Field: {{Custom 1}} - `payload.undeliverable.undeliverableRecipients.metadata.custom2` (string) Mail-Merge Field: {{Custom 2}} - `payload.undeliverable.undeliverableRecipients.metadata.custom3` (string) Mail-Merge Field: {{Custom 3}} - `payload.undeliverable.undeliverableRecipients.metadata.custom4` (string) Mail-Merge Field: {{Custom 4}} - `payload.undeliverable.undeliverableRecipients.metadata.custom5` (string) Mail-Merge Field: {{Custom 5}} - `payload.undeliverable.undeliverableRecipients.metadata.custom6` (string) Mail-Merge Field: {{Custom 6}} - `payload.undeliverable.undeliverableRecipients.metadata.image1` (string) Image-Merge Field: URL to Image 1 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image2` (string) Image-Merge Field: URL to Image 2 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image3` (string) Image-Merge Field: URL to Image 3 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image4` (string) Image-Merge Field: URL to Image 4 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image5` (string) Image-Merge Field: URL to Image 5 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image6` (string) Image-Merge Field: URL to Image 6 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.salutation` (string) Mail-Merge Field: {{Salutation}} - `payload.undeliverable.undeliverableRecipients.metadata.returnTitle` (string) Return Address Override: Return Title. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnFirstName` (string) Return Address Override: Return First Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnLastName` (string) Return Address Override: Return Last Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnOrganization` (string) Return Address Override: Return Organization Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnAddress1` (string) Return Address Override: Return Address 1. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnAddress2` (string) Return Address Override: Return Address 2. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnCity` (string) Return Address Override: Return City. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnZip` (string) Return Address Override: Return Zip. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnState` (string) Return Address Override: Return State. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.email` (string) Mail-Merge Field: {{Email}} - `payload.undeliverable.undeliverableRecipients.metadata.qrUrl` (string) QR URL Override: Providing a QR URL for a recipient overrides the QR URL in the design template. A QR must exist in the design template to provide this field. - `payload.undeliverable.undeliverableRecipients.metadata.text` (string) Handwritten Text: Returns the handwritten text on the design template (if product is handwritten). - `payload.undeliverable.undeliverableRecipients.metadata.text2` (string) Bifold Secondary Handwritten Text: Returns the handwritten text on the bottom panel of the bifold card in design template (if product is Bifold). - `payload.undeliverable.undeliverableRecipients.metadata.radiusPinStreet` (string) Radius Mail: Returns the Radius Pin Street. - `payload.undeliverable.undeliverableRecipients.metadata.radiusPinAddress` (string) Radius Mail: Returns the Radius Pin Address. - `payload.undeliverable.undeliverableRecipients.metadata.fullAddress` (string) Full Address Field: If the full address is provided as single string, the address will be decomposed post-validation into the send address fields. Provide either the FullAddress, or the decomposed fields above (e.g. Address 1, City, State, etc.), both not both. - `payload.orderId` (integer) - `payload.status` (string) - `errors` (array) - `hasErrors` (boolean) - `warnings` (array) - `hasWarnings` (boolean) - `metadata` (object) ## Response 403 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.totalRecipients` (integer) - `payload.deliverable` (object) - `payload.deliverable.addressValidated` (integer) - `payload.deliverable.addressInvalidated` (integer) - `payload.undeliverable` (object) - `payload.undeliverable.duplicated` (integer) - `payload.undeliverable.doNotMail` (integer) - `payload.undeliverable.invalidAddress` (integer) - `payload.undeliverable.undeliverableRecipients` (array) - `payload.undeliverable.undeliverableRecipients.address` (object,null) Recipient Mailing Address. Where the piece will be mailed to. - `payload.undeliverable.undeliverableRecipients.address.address1` (string,null) Recipient Address 1. - `payload.undeliverable.undeliverableRecipients.address.address2` (string,null) Recipient Address 2. - `payload.undeliverable.undeliverableRecipients.address.city` (string,null) Recipient City. - `payload.undeliverable.undeliverableRecipients.address.state` (string,null) Recipient State. - `payload.undeliverable.undeliverableRecipients.address.zipCode` (string,null) Recipient Zip Code. - `payload.undeliverable.undeliverableRecipients.address.zip4` (string,null) Recipient Zip+4. - `payload.undeliverable.undeliverableRecipients.address.zip2` (string,null) Recipient Delivery Point. - `payload.undeliverable.undeliverableRecipients.address.country` (string,null) Recipient Country (Optional, US only). - `payload.undeliverable.undeliverableRecipients.personal` (object,null) Recipient Personal Information - `payload.undeliverable.undeliverableRecipients.personal.firstName` (string,null) Recipient First Name. - `payload.undeliverable.undeliverableRecipients.personal.lastName` (string,null) Recipient Last Name. - `payload.undeliverable.undeliverableRecipients.personal.toOrganization` (string,null) Recipient Organization. - `payload.undeliverable.undeliverableRecipients.personal.salutation` (string) Recipient Salutation (used for Mail-Merge only). - `payload.undeliverable.undeliverableRecipients.metadata` (object,null) Recipient Metadata. This is used for Mail-Merge and Image-merge fields to personalize the mailing to the individual. - `payload.undeliverable.undeliverableRecipients.metadata.dpvConfirmationCode` (string) USPS Delivery Point Verification confirmation code. - `payload.undeliverable.undeliverableRecipients.metadata.custom1` (string) Mail-Merge Field: {{Custom 1}} - `payload.undeliverable.undeliverableRecipients.metadata.custom2` (string) Mail-Merge Field: {{Custom 2}} - `payload.undeliverable.undeliverableRecipients.metadata.custom3` (string) Mail-Merge Field: {{Custom 3}} - `payload.undeliverable.undeliverableRecipients.metadata.custom4` (string) Mail-Merge Field: {{Custom 4}} - `payload.undeliverable.undeliverableRecipients.metadata.custom5` (string) Mail-Merge Field: {{Custom 5}} - `payload.undeliverable.undeliverableRecipients.metadata.custom6` (string) Mail-Merge Field: {{Custom 6}} - `payload.undeliverable.undeliverableRecipients.metadata.image1` (string) Image-Merge Field: URL to Image 1 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image2` (string) Image-Merge Field: URL to Image 2 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image3` (string) Image-Merge Field: URL to Image 3 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image4` (string) Image-Merge Field: URL to Image 4 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image5` (string) Image-Merge Field: URL to Image 5 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.image6` (string) Image-Merge Field: URL to Image 6 variable image defined in template. URL must be publicly accessible. Supported filed formats: JPEG , PNG , WebP , GIF , BMP , and SVG. - `payload.undeliverable.undeliverableRecipients.metadata.salutation` (string) Mail-Merge Field: {{Salutation}} - `payload.undeliverable.undeliverableRecipients.metadata.returnTitle` (string) Return Address Override: Return Title. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnFirstName` (string) Return Address Override: Return First Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnLastName` (string) Return Address Override: Return Last Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnOrganization` (string) Return Address Override: Return Organization Name. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnAddress1` (string) Return Address Override: Return Address 1. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnAddress2` (string) Return Address Override: Return Address 2. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnCity` (string) Return Address Override: Return City. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnZip` (string) Return Address Override: Return Zip. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.returnState` (string) Return Address Override: Return State. This overrides the return address fields set in the design template. - `payload.undeliverable.undeliverableRecipients.metadata.email` (string) Mail-Merge Field: {{Email}} - `payload.undeliverable.undeliverableRecipients.metadata.qrUrl` (string) QR URL Override: Providing a QR URL for a recipient overrides the QR URL in the design template. A QR must exist in the design template to provide this field. - `payload.undeliverable.undeliverableRecipients.metadata.text` (string) Handwritten Text: Returns the handwritten text on the design template (if product is handwritten). - `payload.undeliverable.undeliverableRecipients.metadata.text2` (string) Bifold Secondary Handwritten Text: Returns the handwritten text on the bottom panel of the bifold card in design template (if product is Bifold). - `payload.undeliverable.undeliverableRecipients.metadata.radiusPinStreet` (string) Radius Mail: Returns the Radius Pin Street. - `payload.undeliverable.undeliverableRecipients.metadata.radiusPinAddress` (string) Radius Mail: Returns the Radius Pin Address. - `payload.undeliverable.undeliverableRecipients.metadata.fullAddress` (string) Full Address Field: If the full address is provided as single string, the address will be decomposed post-validation into the send address fields. Provide either the FullAddress, or the decomposed fields above (e.g. Address 1, City, State, etc.), both not both. - `payload.orderId` (integer) - `payload.status` (string) - `errors` (array) - `hasErrors` (boolean) - `warnings` (array) - `hasWarnings` (boolean) - `metadata` (object)