Error responses and what they mean

ERROR_ADDRESSBOOK_DUPLICATE

There is already an address book with that name in the account. Please make sure that the name of the address book you are using is unique and not one of the reserved address book names such as Test or All Contacts.

ERROR_ADDRESSBOOK_INVALID

The address book that you are attempting to create has some invalid properties. Please check the settings you are using for this address book.

ERROR_ADDRESSBOOK_LIMITEXCEEDED

Your account will have a limited number of address books, which depends on the dotMailer edition you are using. You have currently exceeded this limit. Please delete some of your unused address books.

ERROR_ADDRESSBOOK_NOT_FOUND

The address book you have specified with the addressBookId argument does not relate to an address book which exists in the dotMailer account you are currently connected to.

ERROR_ADDRESSBOOK_NOTWRITABLE

The address book you have specified with the addressBookId argument relates to an address book which cannot be written to. For example, you cannot upload contacts to the Test address book via the API.

ERROR_APIUSAGE_EXCEEDED

The last method call you made exceeded the cutoff of 15,000 API calls in a 24 hour window. You will be unable to make any further API calls until the number of API calls made in the last 24 hours goes below this figure. Please review your code to determine what is causing this excess usage.

ERROR_CAMPAIGN_INVALID

The campaign that you are attempting to create has some invalid properties. Please check the settings you are using for this campaign object.

ERROR_CAMPAIGN_NOT_FOUND

The campaign you are trying to get could not be found within the dotMailer account. It is likely that you are using the incorrect ID number.

ERROR_CAMPAIGN_READONLY

The campaign you are trying to update cannot be updated, please check that you have the right ID.

ERROR_CAMPAIGN_SENDNOTPERMITTED

We cannot permit you to send this campaign. This may be because you have not yet verified your account by SMS, or because you have insufficient credit to send.

ERROR_CONTACT_INVALID

The contact you are trying to add is not valid. This means that there is something incorrect with the contact object you are sending to the method. Check that your contact object is valid.

ERROR_CONTACT_NOT_FOUND

The ID of the contact you have selected is not present within the dotMailer account.

ERROR_CONTACT_SUPPRESSED

The contact you are trying to add to the address book has been suppressed. This means that you cannot add the contact back into the address book or the account.

ERROR_CONTACT_SUPPRESSEDFORADDRESSBOOK

The contact you are trying to add has been suppressed for that address book, but not for the account. This means that you cannot add the contact back into the address book, but you may add them to other address books in the same account.

ERROR_CONTACT_TOOMANY

You have exceeded the number of contacts permitted for your account type. Please consider upgrading your account.

ERROR_DATAFIELD_LIMITEXCEEDED

You currently have more than the allowed data fields in your account, despite the fact that we advertise unlimited data fields per account for some account levels. Please delete some of your unused datafields in order to create more.

ERROR_DATAFIELD_NOTFOUND

One or more of the data fields you are trying to set for the contact does not exist. Please make sure that you create any required data fields before attempting to assign values to them.

ERROR_DATAFIELD_INVALID

The datafield you are trying to add is not valid. This means that there is something incorrect with the datafield object you are sending to the method.

ERROR_DOCUMENT_ATTACHMENTSTOOLARGE

The parent folder being listed, or that a document or folder is attempted to be created in, does not exist.

ERROR_DOCUMENT_DATAEMPTY

No document has been supplied when trying to upload a document.

ERROR_DOCUMENT_NAMEINVALID

The name of a document or folder being created or modified is blank or invalid.

ERROR_DOCUMENT_NOTFOUND

No document could be found with the ID supplied.

ERROR_DOCUMENT_PARENTFOLDERDOESNOTEXIST

No document folder could be found with the ID supplied.

ERROR_DOCUMENT_TOOLARGE

The document attempting to be uploaded is too large.

ERROR_DOCUMENT_TOOMANYATTACHMENTS

The campaign that a document is attempting to be attached already has the maximum number of supported attachments.

ERROR_DOCUMENT_UNSUPPORTEDFORMAT

The document attempting to be uploaded is an incorrect or unsupported file type.

ERROR_FEATURENOTACTIVE

The feature you are trying to access is not enabled for this account.

ERROR_IMAGE_PARENTFOLDERDOESNOTEXIST

The parent folder that an image or folder is attempted to be created in does not exist.

ERROR_IMAGE_PARENTFOLDERDELETED

The parent folder that an image or folder is attempted to be created in has been deleted.

ERROR_IMAGE_NAMEINVALID

The name of an image or folder being created is blank or invalid.

ERROR_IMAGE_UNSUPPORTEDFORMAT

The image being uploaded is an incorrect file type (i.e. not an image).

ERROR_IMAGE_DATAEMPTY

No image has been supplied when trying to upload an image.

ERROR_IMPORT_NOT_FOUND

The GUID you have provided does not relate to an import in our system. Please check that you are entering the correct GUID.

ERROR_IMPORT_TOOMANYACTIVEIMPORTS

You currently have more than 4 imports running in one go.

ERROR_INVALID_EMAIL

The email address of the contact you are adding is invalid. Each contact object must contain a valid email address.

ERROR_INVALID_LOGIN

The username or password you are attempting to authenticate your method call with is invalid. Please make sure you have used the correct details. If your login attempt is still unsuccessful please follow the steps to reset your username and password here. This error is also returned if the account you are attempting to connect to is turned off or disabled.

ERROR_NO_EMAIL_COLUMN

The data file you are attempting to import does not contain an Email column. This column is required when importing a file of data.

ERROR_NON_UNIQUE_DATAFIELD

The datafield you are trying to create already exists within the dotMailer account you are connected to. Please either use the existing datafield or choose a different name.

ERROR_NON_UNIQUE_EMAIL

The email address that you are trying to use is not unique.

ERROR_PARAMETER_INVALID

One of the method arguments you are sending is invalid.

ERROR_SEND_LIMITEXCEEDED

You have exceeded the amount of sends your dotMailer account is allowed this month. Please contact your account manager if you wish to send more.

ERROR_SMS_INVALIDPHONENUMBER

The phone number you have attempted to send to is invalid.

ERROR_SMS_SENDNOTPERMITTED

You do not have sufficient credit within your dotMailer account for this SMS send. Please contact your account manager if you need more sending credits.

ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE

The API is temporarily down most likely for scheduled maintenance, you should have received notification of this; if you did not please subscribe to are user warning list here to be notified of these updates in future.

ERROR_TEMPLATE_INVALID

The template that you are attempting to create has some invalid properties. Please check the settings you are using for this template object.

ERROR_TEMPLATE_NOT_FOUND

The template you are trying to get could not be found within the dotMailer account. It is likely that you are using the incorrect ID number.

ERROR_UNKNOWN

We do not know what went wrong. Please contact our support department if you require assistance.

Get started with dotMailer:

Small & Medium businesses Large businesses
Call the team on 0845 337 9170
What our clients say:

dotMailer has changed our complete marketing process for the better. It's one of the easiest apps I have used and allows us to do things we have only dreamed of before.

Amberley Shermon, Cazenove+Loyd