Error List

The API returns the following HTTP status codes when it is unable to fulfill a request:

• 401 – Unauthorized - authentication error (e.g., invalid API Key)
• 400 – Bad Request - invalid parameterization or violation of a business rule that prevents fulfilling the request

Error Object

In certain error scenarios, the response body will contain an object with details about the occurred error:

{
    code: "",
    param: "",
    description: ""
}

The meaning of the fields is as follows:

• code - error code;
• param - name of the parameter that caused the error (if applicable);
• description - textual description of the error.

Error Codes

The following error codes may be returned:

General

Code	Description
PARAM_INVALID	Invalid parameter value (parameter name specified in the param field).
PARAM_EXCEEDS_MAX_LENGTH	Parameter value exceeds maximum length (parameter name specified in the param field).
PAYLOAD_EXCEEDS_MAX_SIZE	Request payload exceeds maximum size.
GENERIC_ERROR	Generic error. Contact the support team

Audience

Code	Description
INCOMPLETE_KEY_COLUMN_MAPPING	Not all required key fields found in the provided object.
INVALID_KEY_CONFIGURATION	Invalid key field value.
SCHEMA_MISMATCH	Incompatible schema.
AUDIENCE_SCHEMA_NOT_FOUND	Organization schema not found.
RECIPIENT_ALREADY_EXISTS	Contact already exists.
MAX_PLAN_RECIPIENT_COUNT_REACHED	Maximum number of allowed audience contacts for the plan reached.

Send Email

Code	Description
FROM_NOT_ALLOWED	Email sender not authorized. Refer to the domain configuration section.
NO_CONTENT_DEFINED	No content defined for sending in the TextContent or HtmlContent fields.
EMAIL_ATTACHMENTS_NOT_ALLOWED	Email attachment sending not allowed.
ATTACHMENT_PARAM_EMPTY	Attachment parameter is empty.
ATTACHMENT_PARAM_TOO_LONG	Attachment parameter exceeds maximum size.
ATTACHMENT_PARAM_INVALID	Invalid attachment parameter.
INVALID_WEBHOOK_URL	Invalid webhook URL.
INSUFFICIENT_BALANCE	Organization does not have enough balance to send the message
TOO_MANY_RECIPIENTS	Too many recipients have been configured on the To, CC, BCC properties - there is a cumulative limit of 50 recipients for each individual Email message

Send SMS

Code	Description
FROM_NOT_ALLOWED	SMS sender not authorized. Refer to the domain configuration section.
MOBILE_OPERATOR_NOT_FOUND	Mobile operator not found.
INVALID_WEBHOOK_URL	Invalid webhook URL.
INSUFFICIENT_BALANCE	Organization does not have enough balance to send the message
WEBHOOK_CUSTOM_PAYLOAD_EXCEEDS_MAX_LENGTH	Content of the CustomPayload field exceeds the maximum size of 1KB