Error Handling

Errors are returned with a numeric code, type string, and human-readable message.

For batch requests, errors will be returned individually within the list for the bad individual items, in the order they were processed.

See the example error result on the right for a DELETE issued against a request that was already canceled.

Common Errors

Invalid client key

This request was not using your correct partner_id.

"error": {
    "message": "invalid client key: 3c17e3cacfa390c6b1cd1f44336fae6f",
    "code": "160",
    "type": "UnauthorizedException"


403 Forbidden

If you use a JSON-formatted request body, include the header 'Content-Type: application/json' in your request.

  <title>403 Forbidden</title>
  <p>You don't have permission to access /api/partner/1.0/email_requests
  on this server.</p>


Invalid location_id

The specific location_id being passed in is not correct for the property.

"error": {
   "message": "The value of location_id is not valid.",
    "code": "111",
    "type": "BadRequestException"


Permission error

The property owner has not opted in to allow the sending of emails.

"error": {
    "message": "You do not have permission to access this email_requests.",
    "code": "191",
    "type": "You do not have permission to access this object"


Email request exceeds 10,000 characters

The text of the email body is too long.

"error": {
    "message": "Email request API call body exceeds 10000 character limit",
    "code": "141",
    "type": "StringTooLongException"