Skip to main content

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​

CodeDescription
PARAM_INVALIDInvalid parameter value (parameter name specified in the param field).
FEATURE_IS_DISABLEDFeature not enabled for organization.
PARAM_EXCEEDS_MAX_LENGTHParameter value exceeds maximum length (parameter name specified in the param field).
PAYLOAD_EXCEEDS_MAX_SIZERequest payload exceeds maximum size.
INVALID_URLInvalid URL
GENERIC_ERRORGeneric error. Contact the support team

Audience​

CodeDescription
INCOMPLETE_KEY_COLUMN_MAPPINGNot all required key fields found in the provided object.
INVALID_KEY_CONFIGURATIONInvalid key field value.
SCHEMA_MISMATCHIncompatible schema.
AUDIENCE_SCHEMA_NOT_FOUNDOrganization schema not found.
RECIPIENT_ALREADY_EXISTSContact already exists.
MAX_PLAN_RECIPIENT_COUNT_REACHEDMaximum number of allowed audience contacts for the plan reached.

Send Email​

CodeDescription
FROM_NOT_ALLOWEDEmail sender not authorized. Refer to the domain configuration section.
NO_CONTENT_DEFINEDNo content defined for sending in the TextContent or HtmlContent fields.
EMAIL_ATTACHMENTS_NOT_ALLOWEDEmail attachment sending not allowed.
ATTACHMENT_PARAM_EMPTYAttachment parameter is empty.
ATTACHMENT_PARAM_TOO_LONGAttachment parameter exceeds maximum size.
ATTACHMENT_PARAM_INVALIDInvalid attachment parameter.
INVALID_WEBHOOK_URLInvalid webhook URL.
INSUFFICIENT_BALANCEOrganization does not have enough balance to send the message
TOO_MANY_RECIPIENTSToo 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​

CodeDescription
FROM_NOT_ALLOWEDSMS sender not authorized. Refer to the domain configuration section.
MOBILE_OPERATOR_NOT_FOUNDMobile operator not found.
INVALID_WEBHOOK_URLInvalid webhook URL.
INSUFFICIENT_BALANCEOrganization does not have enough balance to send the message
WEBHOOK_CUSTOM_PAYLOAD_EXCEEDS_MAX_LENGTHContent of the CustomPayload field exceeds the maximum size of 1KB

Check Balance​

CodeDescription
ORGANIZATION_ID_EMPTYOrganization identifier not specified
ORGANIZATION_BALANCE_CONFIG_NOT_FOUNDInvalid balance configuration. If the issue persists, please contact the support team.

Transfer Email Balance​

CodeDescription
SOURCE_ORGANIZATION_ID_EMPTYSource organization identifier not specified
DESTINATION_ORGANIZATION_ID_EMPTYDestination organization identifier not specified
BALANCE_TRANSFER_FAILEDThe balance transfer could not be completed. If the issue persists, please contact the support team.

Transfer SMS Balance​

CodeDescription
SOURCE_ORGANIZATION_ID_EMPTYSource organization identifier not specified
DESTINATION_ORGANIZATION_ID_EMPTYDestination organization identifier not specified
COUNTRY_ID_EMPTYCountry code not specified
INVALID_COUNTRY_IDInvalid country code. This code must follow the ISO 3166-1 alpha-2 standard
BALANCE_TRANSFER_FAILEDThe balance transfer could not be completed. If the issue persists, please contact the support team.

SMS Sender Creation​

CodeDescription
ORGANIZATION_ID_EMPTYOrganization identifier not specified.
SENDER_ALREADY_EXISTSThe sender already exists in the organization.
FILE_DATA_IS_INVALIDInvalid file data. The file content must be provided as a Base64-encoded string.
SENDER_FILE_EXTENSION_INVALIDInvalid file name extension.
SENDER_FILE_EXCEEDS_MAX_SIZEThe sender file exceeds the maximum size of 10 MB.
INVALID_MIME_TYPEInvalid file MIME type.
SENDER_NAME_INVALIDInvalid sender name.
SENDER_CREATION_FAILEDThe sender could not be created. If the problem persists, contact the support team.