XML Recipient and Content Error Elements

This section contains these elements and their definitions:

  • RECIPIENT_DETAIL
  • EMAIL
  • SEND_STATUS
  • ERROR_CODE
  • ERROR_STRING

Element: RECIPIENT_DETAIL - This required, top level element is used for each recipient and can occur multiple times.

  • Element type: Complex
  • Data type: String
  • Default Value: N/A
  • Limit: 255 characters
  • Values: Error message text.
  • Occurrence indicators:
  • minOccurs="1" - Values: 1 = at least one of them is required.
  • maxOccurs="unbounded" - Values: unbounded= (no limit)
  • Attributes: None
<RECIPIENT_DETAIL>
    <EMAIL></EMAIL>
    <SEND_STATUS></SEND_STATUS>
    <ERROR_CODE></ERROR_CODE>
    <ERROR_STRING></ERROR_STRING>
</RECIPIENT_DETAIL>

Element: EMAIL - This required element contains the email address to which the transactional email was sent. The sequence for this element is after the RECIPIENT_DETAIL element.

  • Element type: Complex
  • Data type: String
  • Default Value: N/A
  • Limit: 255 characters
  • Values: Address text.
  • Occurrence indicators:
  • minOccurs="1" - Values: 1 = at least one of them is required.
  • Attributes: None

Example:[email protected]
Element: SEND_STATUS - This required element shows the status of the send to the recipient.The sequence for this element is after the EMAIL element.

  • Element type: Complex
  • Data type: unsignedInt
  • Default Value: N/A
  • Limit: N/A
  • Values:
  • 0 - no errors that are encountered during the send.
  • 1 - Encountered an error during the send, will not retry the send.
  • 2 - request received; send cached for later send.
  • Occurrence indicators: None
  • Attributes: None

Example: <SEND_STATUS>1</SEND_STATUS>
Element: ERROR_CODE- This required element shows the error code that is generated for the specific recipient.The sequence for this element is after the SEND_STATUS element.

  • Element type: Complex
  • Data type: unsignedInt
  • Default Value: N/A
  • Limit: N/A
  • Values: 1 n = Number identifying the error code.
  • Occurrence indicators: None
  • Attributes: None

Example: <ERROR_CODE>4</ERROR_CODE>
See:Error Codes in XML Response Documents
Element: ERROR_STRING- This required element shows the error message that is generated for the specific recipient..The sequence for this element is after the ERROR_CODE element.

  • Element type: Complex
  • Data type: String
  • Default Value: N/A
  • Limit: 255 characters
  • Values: Error message text.
  • Occurrence indicators: None
  • Attributes: None

Example: <ERROR_STRING>Campaign ID is missing</ERROR_STRING>
See:Error Codes in XML Response Documents


Did this page help you?