{"_id":"55e96030e5d0c623003ed885","__v":23,"githubsync":"","parentDoc":null,"version":{"_id":"55dd9f4dab0e4d210045aae9","__v":44,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"project":"55dd9f2e0efd5821000d54d9","category":{"_id":"55dd9f4dab0e4d210045aaea","pages":["55dd9f4dab0e4d210045aaeb","55e96008ffba3323004216ea","55e96030e5d0c623003ed885","55e97a097f564237001d5b80","56795de3ade8221700923d2c","56797b1584397c0d00fe13ea"],"version":"55dd9f4dab0e4d210045aae9","__v":6,"project":"55dd9f2e0efd5821000d54d9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-26T11:12:47.544Z","from_sync":false,"order":2,"slug":"overview","title":"API overview"},"user":"55dd9841cafe7221002a4c62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-04T09:11:12.891Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"With the dotmailer API, you can expect conventional HTTP response codes to indicate the success or failure of an API request. \n\nTypically, HTTP response codes mean:\n\n * 200 range - a successful request\n * 400 range - a failed request (a request parameter wasn't included, an object couldn't be found, etc.)\n * 500 range - an error with our servers (these will be rare)\n\n400 range HTTP response codes indicating a failed request come with an error response type in the body of the response, all of which are outlined below: \n\n**ERROR_ACCOUNT_INVALID**\nThe account is not valid. This means you are trying to reference an account that doesn’t exist or has certain restrictions placed upon it. Please contact our support department if you require assistance.\n\n**ERROR_ADDRESSBOOK_DUPLICATE**\nThere 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'.\n\n**ERROR_ADDRESSBOOK_IN_USE** \nThe address book you are attempting to use in your request is in use – retrying later may succeed.\n\n**ERROR_ADDRESSBOOK_INVALID**\nThis address book is not valid. This means that there is something incorrect with the address book object you are sending to the method/operation, or you are referring to a non-existent address book. Check that your address book object is valid by checking the definition in the documentation.\n\n**ERROR_ADDRESSBOOK_LIMITEXCEEDED**\nYour account will have a limited number of address books, which depends on the level of account you're using. You have currently exceeded this limit. Please delete some of your unused address books.\n\n**ERROR_ADDRESSBOOK_NOT_FOUND**\nThe address book you have specified with the addressBookId argument does not relate to an address book which exists in the account you are currently connected to.\n\n**ERROR_ADDRESSBOOK_NOTWRITABLE**\nThe 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.\n\n**ERROR_ADDRESSBOOK_TOOMANY** \nYou have requested program enrolment from too many address books. Please reduce the number of address books in your array. \n\n**ERROR_APIUSAGE_EXCEEDED**\nThe last method/operation call you made exceeded the cut-off of 2000 API calls in a one hour period. You will be unable to make any further API calls until the number of API calls made in the last hour goes below this figure. Please review your code to determine what is causing this excess usage.\n\n**ERROR_APIUSER_INVALID**\n The API user credentials that you have used in the request are invalid. You may have entered them incorrectly. Please check that your credentials are being entered correctly.\n\n**ERROR_BODY_DOES_NOT_MATCH_CONTENT_TYPE**\nThe body of your request does not match the content type. Please check that the content type is set correctly.\n\n**ERROR_CAMPAIGN_CONTAINS_UNSUPPORTED_BLOCKS** - The campaign you're attempting to send can't be sent because it contains [unsupported EasyEditor building blocks and links](doc:sending-a-transactional-email-as-a-triggered-campaign#section-unsupported-easyeditor-building-blocks-and-links).\n\n**ERROR_CAMPAIGN_INVALID**\nThe campaign that you are attempting to create has some invalid properties. Please check the settings you are using for this campaign.\n\n**ERROR_CAMPAIGN_NOT_FOUND**\nThe campaign you are trying to get could not be found within the account. It is likely that you are using the incorrect ID number.\n\n**ERROR_CAMPAIGN_READONLY**\nThe campaign you are trying to update cannot be updated - please check that you have the right ID.\n\n**ERROR_CAMPAIGN_SEND_INVALID**\nThe campaign send is not valid. This means that there is something incorrect with the campaign send object you are sending to the method/operation. Check that your campaign send object is valid by checking the definition in the documentation.\n\n**ERROR_CAMPAIGN_SENDNOTPERMITTED**\nWe cannot permit you to send this campaign. This will most likely be because your account is not fully enabled.\n\n**ERROR_CANNOT_PERFORM_OPERATION_ON_ACCOUNT**\nThe operation that your request is trying to perform can’t be executed on your account.\n\n**ERROR_CONTACTS_ARE_NOT_SPECIFIED**\nThe request you are making is not specifying the contacts that are required. Make sure you have included these in your request.\n\n**ERROR_CONTACT_INVALID**\nThe 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/operation. Check that your contact object is valid by checking the definition in the documentation.\n\n**ERROR_CONTACT_NOT_FOUND**\nThe ID of the contact you have selected is not present within the account.\n\n**ERROR_CONTACT_RESUBSCRIPTION_INVALID**\nThe contact resubscription is not valid. This means that there is something incorrect with the contact resubscription object you are sending to the method/operation. Check that your contact resubscription object is valid by checking the definition in the documentation.\n\n**ERROR_CONTACT_SUPPRESSED**\nThe 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.\n\n**ERROR_CONTACT_SUPPRESSEDFORADDRESSBOOK**\nThe contact you are attempting to add is suppressed for this address book.\n\n**ERROR_CONTACT_TOOMANY**\nYou have exceeded the number of contacts permitted for your account type. Please consider upgrading your account.\n\n**ERROR_CONTENT_TYPE_IS_NOT_SUPPORTED**\nThe content type is not supported. Please check that you have set a supported content type for your request.\n\n**ERROR_DATAFIELD_INVALID**\nThe data field is not valid. This means that there is something incorrect with the data field object you are sending to the method/operation, or you are referring to a non-existent data field. Check that your data field object is valid by checking the definition in the documentation.\n\n**ERROR_DATAFIELD_LIMITEXCEEDED**\nYou currently have more than the allowed contact data fields in your account, despite the fact that we advertise unlimited contact data fields per account for some account levels. Please delete some of your unused contact data fields in order to create more.\n\n**ERROR_DATAFIELD_NOTFOUND**\nOne or more of the contact data fields you are trying to set for the contact does not exist. Please make sure that you create any required contact data fields before attempting to assign values to them.\n\n**ERROR_DATAFIELD_VALUE_OVERFLOW**\nThere has been a data field value overflow.\n\n**ERROR_DOCUMENT_ATTACHMENTSTOOLARGE**\nYour attachments are too large. They have reached the maximum limit. Please reduce the size.\n\n**ERROR_DOCUMENT_DATAEMPTY**\nThere is no data supplied for this document object. Please ensure this document exists in your account and has valid data.\n\n**ERROR_DOCUMENT_FOLDER_INVALID**\nThe document folder is not valid. This means that there is something incorrect with the document folder object you are sending to the method/operation. Check that your document folder object is valid by checking the definition in the documentation.\n\n**ERROR_DOCUMENT_FOLDER_NOT_FOUND**\nThe document folder could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.\n\n**ERROR_DOCUMENT_INVALID**\nThe document is not valid. This means that there is something incorrect with the document object you are sending to the method/operation. Check that your document object is valid by checking the definition in the documentation.\n\n**ERROR_DOCUMENT_NAMEINVALID**\nThe document provided has an invalid name. Please check that the name is correct.\n\n**ERROR_DOCUMENT_NOT_FOUND**\nThe document object could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.\n\n**ERROR_DOCUMENT_TOOLARGE**\nThe document that you're attempting to add is too large. It exceeds the maximum size of 10MB.\n\n**ERROR_DOCUMENT_TOOMANYATTACHMENTS**\nYour campaign has reached the maximum amount of attachments it is allowed to have. Please reduce this amount.\n\n**ERROR_DOCUMENT_UNSUPPORTEDFORMAT**\nThe document is not in a supported format. Please ensure you use the correct format.\n\n**ERROR_DOCUMENT_ALREADYATTACHED**\nYou are attempting to attach a document object that is already attached to this campaign.\n\n**ERROR_EMAIL_BANNED**\nYou are attempting to add an email address that is banned from the system.\n\n**ERROR_ENROLMENT_ALLOWANCE_EXCEEDED** \nYou have exceeded the limit of 20 calls per hour for creating program enrolments across all programs. You will be unable to make any further calls to create program enrolments until the number made in the last hour goes below this figure.\n\n**ERROR_ENROLMENT_INVALID** \nThe program enrolment you are trying to create or retrieve is not valid. This means that there is something incorrect with the enrolment object you are sending to the method/operation. Check that your enrolment object is valid by checking the definition in the documentation.\n\n**ERROR_ENROLMENT_IS_PROCESSING** \nThe program enrolment faults report in your request can’t be retrieved because the enrolment is still processing.\n\n**ERROR_ENROLMENT_NOT_FOUND**\nThe program enrolment you are trying to retrieve or reference in your call does not exist. Please make sure that the program enrolment ID (GUID) you are using is correct.\n\n**ERROR_FEATURENOTACTIVE**\nThe feature your call is referencing is not active on your account (e.g. transactional email). Please make sure this feature is enabled before calling it again.\n\n**ERROR_IMAGE_DATAEMPTY**\nThere is no data supplied for this image object. Please ensure this image exists in your account and has valid data.\n\n**ERROR_IMAGE_FOLDER_NOT_FOUND**\nThe ID of the image folder could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.\n\n**ERROR_IMAGE_FOLDER_DELETED**\nThe image folder you have selected has been deleted.\n\n**ERROR_IMAGE_FOLDER_INVALID**\nThe image folder is not valid. This means that there is something incorrect with the image folder object you are sending to the method/operation. Check that your image folder object is valid by checking the definition in the documentation.\n\n**ERROR_IMAGE_INVALID**\nThe image is not valid. This means that there is something incorrect with the image object you are sending to the method/operation. Check that your image object is valid by checking the definition in the documentation.\n\n**ERROR_IMAGE_NAMEINVALID**\nThe image object provided has an invalid name. Please check that the name is correct.\n\n**ERROR_IMAGE_PARENTFOLDERISFULL**\nThe parent image folder that you are attempting to add the child folder to is now full.\n\n**ERROR_IMAGE_UNSUPPORTEDFORMAT**\nThe image object is not in a supported format. Please ensure you use the correct format.\n\n**ERROR_IMPORT_NOT_FOUND**\nThe GUID you have provided does not relate to an import in our system. Please check that you are entering the correct GUID.\n\n**ERROR_IMPORT_REPORT_NOT_FOUND**\nThe import report object could not be found within the account. Please check that you are entering the correct GUID.\n\n**ERROR_IMPORT_TOOMANYACTIVEIMPORTS**\nYou currently have more than four imports running in one go.\n\n**ERROR_IMPORT_UNSUPPORTED_FORMAT**\nThe import object is not in a supported format. Please ensure you use the correct format.\n\n**ERROR_INVALID_APIUSEREXISTS**\n You cannot attempt to recreate an API user which already exists.\n\n**ERROR_INVALID_EMAIL**\nThe email address of the contact you are adding is invalid. Each contact object must contain a valid email address.\n\n**ERROR_INVALID_LOGIN**\nThe 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 as set out in the documentation. This error is also returned if the account you are attempting to connect to is turned off or disabled.\n\n**ERROR_INVALID_PERSONALISATION_VALUES**\nThe personalisation values you've used aren't valid JSON strings and aren't escaped properly (especially when an HTML string is provided in the 'Value').\n\n**ERROR_MALFORMED_REQUEST**\nYour request is not formed correctly. Please check our documentation to make sure you have included all of the required parameters in your request and that it is formed correctly.\n\n**ERROR_MANAGED_USER_INVALID**\nThe API managed user credentials that you have used in the request are invalid. You may have entered them incorrectly. Please check that the managed user credentials are being entered correctly.\n\n**ERROR_MISSING_SETUPKEYVALUES** \nYou have not included all setup keys.\n\n**ERROR_MULTI_FILE_UPLOAD_NOT_ALLOWED**\nYou have attempted to upload multiple files in a call, which isn’t allowed. Please upload one file per call.\n\n**ERROR_NO_EMAIL_COLUMN**\nThe data file you are attempting to import does not contain an Email column. This column is required when importing a file of data.\n\n**ERROR_NON_UNIQUE_DATAFIELD**\nThe data field you are trying to create already exists within the account you are connected to. Please either use the existing data field or choose a different name.\n\n**ERROR_NON_UNIQUE_EMAIL**\nThe email address that you are trying to use is not unique.\n\n**ERROR_OAUTH_TOKEN_INVALID**\n The OAuth token being entered with the call is invalid. You may have entered it incorrectly. Please check that the OAuth token is being entered correctly.\n\n**ERROR_PARAMETER_INVALID**\nOne of the method/operation arguments you are sending is invalid.\n\n**ERROR_PROGRAM_NOT_ACTIVE**\nYou are attempting to create a program enrolment for a program that isn’t yet active. A program must be active before it can enrol.\n\n**ERROR_PROGRAM_NOT_FOUND**\nThe program you are trying to retrieve or reference in your call does not exist. Please make sure that the program ID you are using is correct.\n\n**ERROR_SEGMENT_NOT_FOUND**\nThe segment object could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.\n\n**ERROR_SEND_LIMITEXCEEDED**\nYou have exceeded the amount of sends your account is allowed this month. Please contact your account manager if you wish to send more.\n\n**ERROR_SMS_INVALID**\nThe SMS is not valid. This means that there is something incorrect with the SMS object you are sending to the method/operation. Check that your SMS object is valid by checking the definition in the documentation.\n\n**ERROR_SMS_INVALIDPHONENUMBER**\nThe phone number you have attempted to send to is invalid.\n\n**ERROR_SMS_SENDNOTPERMITTED**\nYou do not have sufficient credit within your account for this SMS send. Please contact your account manager if you need more sending credits.\n\n**ERROR_SURVEY_NOT_FOUND**\nThe survey you are trying to retrieve or reference in your call does not exist. Please make sure that the survey ID you are using is correct.\n\n**ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE**\nThe API is temporarily down, most likely for scheduled maintenance, for which you should have received notification; if you did not please subscribe to our user warning list to be notified of these updates in future.\n\n**ERROR_TRANSACTIONAL_DATA_COLLECTION_DOES_NOT_EXIST** \nThe transactional data collection you are trying to retrieve or reference in your call does not exist. Please make sure that the collection name you are using is correct.\n\n**ERROR_TRANSACTIONAL_DATA_INVALID_COLLECTION_NAME** \nThe transactional data collection name you are trying to create isn't valid. Valid transactional data collection names can only contain alphanumeric characters (A-Z, a-z, 0-9), dashes ( - ) and underscores ( _ ), they can't start with a number and they can't exceed 255 characters in length. Please make sure that the collection name you are creating is valid.\n\n**ERROR_TEMPLATE_INVALID**\nThe template is not valid. This means that there is something incorrect with the template object you are sending to the method/operation. Check that your template object is valid by checking the definition in the documentation.\n\n**ERROR_TEMPLATE_NOT_FOUND**\nThe template object could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.\n\n**ERROR_THEME_INVALID**\nYou are attempting to set up an account with an invalid theme. Please check that the theme is correct.\n\n**ERROR_TRANSACTIONAL_DATA_DOES_NOT_EXIST**\nThis piece of transactional data does not exist. Either it has been deleted or it is likely that you are using the incorrect collection name or key.\n\n**ERROR_TRANSACTIONAL_DATA_STORAGE_ALLOWANCE_EXCEEDED**\nYou have exceeded your transactional data storage allowance.\n\n**ERROR_TRANSACTIONAL_DATA_VALIDATION_FAILED**\nThe validation of the transactional data failed. This means that there is something incorrect with the transactional data object you are sending to the method/operation. Check that your transactional data object is valid by checking the definition in the documentation.\n\n**ERROR_UNKNOWN**\nWe don't know what went wrong. Please contact our support department if you require assistance.\n\n**ERROR_UNKNOWN_ACCOUNT** \nThe account is unknown. This means you are trying to reference an account that isn’t recognised. Please contact our support department if you require assistance.\n\n**ERROR_USERACCOUNT_UNKNOWN**\nThis user account is not known. Please check the details you are using are valid.\n\n**ERROR_WEAK_PASSWORD**\nThe password set for your API credentials is too weak.","excerpt":"Here's a list of the error response types you can expect to receive when an API request fails","slug":"error-response-types","type":"basic","title":"Error response types"}

Transactional email

More help

Error response types

Here's a list of the error response types you can expect to receive when an API request fails

With the dotmailer API, you can expect conventional HTTP response codes to indicate the success or failure of an API request.
Typically, HTTP response codes mean:
* 200 range - a successful request
* 400 range - a failed request (a request parameter wasn't included, an object couldn't be found, etc.)
* 500 range - an error with our servers (these will be rare)
400 range HTTP response codes indicating a failed request come with an error response type in the body of the response, all of which are outlined below:
**ERROR_ACCOUNT_INVALID**
The account is not valid. This means you are trying to reference an account that doesn’t exist or has certain restrictions placed upon it. Please contact our support department if you require assistance.
**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_IN_USE**
The address book you are attempting to use in your request is in use – retrying later may succeed.
**ERROR_ADDRESSBOOK_INVALID**
This address book is not valid. This means that there is something incorrect with the address book object you are sending to the method/operation, or you are referring to a non-existent address book. Check that your address book object is valid by checking the definition in the documentation.
**ERROR_ADDRESSBOOK_LIMITEXCEEDED**
Your account will have a limited number of address books, which depends on the level of account you're 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 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_ADDRESSBOOK_TOOMANY**
You have requested program enrolment from too many address books. Please reduce the number of address books in your array.
**ERROR_APIUSAGE_EXCEEDED**
The last method/operation call you made exceeded the cut-off of 2000 API calls in a one hour period. You will be unable to make any further API calls until the number of API calls made in the last hour goes below this figure. Please review your code to determine what is causing this excess usage.
**ERROR_APIUSER_INVALID**
The API user credentials that you have used in the request are invalid. You may have entered them incorrectly. Please check that your credentials are being entered correctly.
**ERROR_BODY_DOES_NOT_MATCH_CONTENT_TYPE**
The body of your request does not match the content type. Please check that the content type is set correctly.
**ERROR_CAMPAIGN_CONTAINS_UNSUPPORTED_BLOCKS** - The campaign you're attempting to send can't be sent because it contains [unsupported EasyEditor building blocks and links](doc:sending-a-transactional-email-as-a-triggered-campaign#section-unsupported-easyeditor-building-blocks-and-links).
**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.
**ERROR_CAMPAIGN_NOT_FOUND**
The campaign you are trying to get could not be found within the 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_SEND_INVALID**
The campaign send is not valid. This means that there is something incorrect with the campaign send object you are sending to the method/operation. Check that your campaign send object is valid by checking the definition in the documentation.
**ERROR_CAMPAIGN_SENDNOTPERMITTED**
We cannot permit you to send this campaign. This will most likely be because your account is not fully enabled.
**ERROR_CANNOT_PERFORM_OPERATION_ON_ACCOUNT**
The operation that your request is trying to perform can’t be executed on your account.
**ERROR_CONTACTS_ARE_NOT_SPECIFIED**
The request you are making is not specifying the contacts that are required. Make sure you have included these in your request.
**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/operation. Check that your contact object is valid by checking the definition in the documentation.
**ERROR_CONTACT_NOT_FOUND**
The ID of the contact you have selected is not present within the account.
**ERROR_CONTACT_RESUBSCRIPTION_INVALID**
The contact resubscription is not valid. This means that there is something incorrect with the contact resubscription object you are sending to the method/operation. Check that your contact resubscription object is valid by checking the definition in the documentation.
**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 attempting to add is suppressed for this address book.
**ERROR_CONTACT_TOOMANY**
You have exceeded the number of contacts permitted for your account type. Please consider upgrading your account.
**ERROR_CONTENT_TYPE_IS_NOT_SUPPORTED**
The content type is not supported. Please check that you have set a supported content type for your request.
**ERROR_DATAFIELD_INVALID**
The data field is not valid. This means that there is something incorrect with the data field object you are sending to the method/operation, or you are referring to a non-existent data field. Check that your data field object is valid by checking the definition in the documentation.
**ERROR_DATAFIELD_LIMITEXCEEDED**
You currently have more than the allowed contact data fields in your account, despite the fact that we advertise unlimited contact data fields per account for some account levels. Please delete some of your unused contact data fields in order to create more.
**ERROR_DATAFIELD_NOTFOUND**
One or more of the contact data fields you are trying to set for the contact does not exist. Please make sure that you create any required contact data fields before attempting to assign values to them.
**ERROR_DATAFIELD_VALUE_OVERFLOW**
There has been a data field value overflow.
**ERROR_DOCUMENT_ATTACHMENTSTOOLARGE**
Your attachments are too large. They have reached the maximum limit. Please reduce the size.
**ERROR_DOCUMENT_DATAEMPTY**
There is no data supplied for this document object. Please ensure this document exists in your account and has valid data.
**ERROR_DOCUMENT_FOLDER_INVALID**
The document folder is not valid. This means that there is something incorrect with the document folder object you are sending to the method/operation. Check that your document folder object is valid by checking the definition in the documentation.
**ERROR_DOCUMENT_FOLDER_NOT_FOUND**
The document folder could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.
**ERROR_DOCUMENT_INVALID**
The document is not valid. This means that there is something incorrect with the document object you are sending to the method/operation. Check that your document object is valid by checking the definition in the documentation.
**ERROR_DOCUMENT_NAMEINVALID**
The document provided has an invalid name. Please check that the name is correct.
**ERROR_DOCUMENT_NOT_FOUND**
The document object could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.
**ERROR_DOCUMENT_TOOLARGE**
The document that you're attempting to add is too large. It exceeds the maximum size of 10MB.
**ERROR_DOCUMENT_TOOMANYATTACHMENTS**
Your campaign has reached the maximum amount of attachments it is allowed to have. Please reduce this amount.
**ERROR_DOCUMENT_UNSUPPORTEDFORMAT**
The document is not in a supported format. Please ensure you use the correct format.
**ERROR_DOCUMENT_ALREADYATTACHED**
You are attempting to attach a document object that is already attached to this campaign.
**ERROR_EMAIL_BANNED**
You are attempting to add an email address that is banned from the system.
**ERROR_ENROLMENT_ALLOWANCE_EXCEEDED**
You have exceeded the limit of 20 calls per hour for creating program enrolments across all programs. You will be unable to make any further calls to create program enrolments until the number made in the last hour goes below this figure.
**ERROR_ENROLMENT_INVALID**
The program enrolment you are trying to create or retrieve is not valid. This means that there is something incorrect with the enrolment object you are sending to the method/operation. Check that your enrolment object is valid by checking the definition in the documentation.
**ERROR_ENROLMENT_IS_PROCESSING**
The program enrolment faults report in your request can’t be retrieved because the enrolment is still processing.
**ERROR_ENROLMENT_NOT_FOUND**
The program enrolment you are trying to retrieve or reference in your call does not exist. Please make sure that the program enrolment ID (GUID) you are using is correct.
**ERROR_FEATURENOTACTIVE**
The feature your call is referencing is not active on your account (e.g. transactional email). Please make sure this feature is enabled before calling it again.
**ERROR_IMAGE_DATAEMPTY**
There is no data supplied for this image object. Please ensure this image exists in your account and has valid data.
**ERROR_IMAGE_FOLDER_NOT_FOUND**
The ID of the image folder could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.
**ERROR_IMAGE_FOLDER_DELETED**
The image folder you have selected has been deleted.
**ERROR_IMAGE_FOLDER_INVALID**
The image folder is not valid. This means that there is something incorrect with the image folder object you are sending to the method/operation. Check that your image folder object is valid by checking the definition in the documentation.
**ERROR_IMAGE_INVALID**
The image is not valid. This means that there is something incorrect with the image object you are sending to the method/operation. Check that your image object is valid by checking the definition in the documentation.
**ERROR_IMAGE_NAMEINVALID**
The image object provided has an invalid name. Please check that the name is correct.
**ERROR_IMAGE_PARENTFOLDERISFULL**
The parent image folder that you are attempting to add the child folder to is now full.
**ERROR_IMAGE_UNSUPPORTEDFORMAT**
The image object is not in a supported format. Please ensure you use the correct format.
**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_REPORT_NOT_FOUND**
The import report object could not be found within the account. Please check that you are entering the correct GUID.
**ERROR_IMPORT_TOOMANYACTIVEIMPORTS**
You currently have more than four imports running in one go.
**ERROR_IMPORT_UNSUPPORTED_FORMAT**
The import object is not in a supported format. Please ensure you use the correct format.
**ERROR_INVALID_APIUSEREXISTS**
You cannot attempt to recreate an API user which already exists.
**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 as set out in the documentation. This error is also returned if the account you are attempting to connect to is turned off or disabled.
**ERROR_INVALID_PERSONALISATION_VALUES**
The personalisation values you've used aren't valid JSON strings and aren't escaped properly (especially when an HTML string is provided in the 'Value').
**ERROR_MALFORMED_REQUEST**
Your request is not formed correctly. Please check our documentation to make sure you have included all of the required parameters in your request and that it is formed correctly.
**ERROR_MANAGED_USER_INVALID**
The API managed user credentials that you have used in the request are invalid. You may have entered them incorrectly. Please check that the managed user credentials are being entered correctly.
**ERROR_MISSING_SETUPKEYVALUES**
You have not included all setup keys.
**ERROR_MULTI_FILE_UPLOAD_NOT_ALLOWED**
You have attempted to upload multiple files in a call, which isn’t allowed. Please upload one file per call.
**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 data field you are trying to create already exists within the account you are connected to. Please either use the existing data field or choose a different name.
**ERROR_NON_UNIQUE_EMAIL**
The email address that you are trying to use is not unique.
**ERROR_OAUTH_TOKEN_INVALID**
The OAuth token being entered with the call is invalid. You may have entered it incorrectly. Please check that the OAuth token is being entered correctly.
**ERROR_PARAMETER_INVALID**
One of the method/operation arguments you are sending is invalid.
**ERROR_PROGRAM_NOT_ACTIVE**
You are attempting to create a program enrolment for a program that isn’t yet active. A program must be active before it can enrol.
**ERROR_PROGRAM_NOT_FOUND**
The program you are trying to retrieve or reference in your call does not exist. Please make sure that the program ID you are using is correct.
**ERROR_SEGMENT_NOT_FOUND**
The segment object could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.
**ERROR_SEND_LIMITEXCEEDED**
You have exceeded the amount of sends your account is allowed this month. Please contact your account manager if you wish to send more.
**ERROR_SMS_INVALID**
The SMS is not valid. This means that there is something incorrect with the SMS object you are sending to the method/operation. Check that your SMS object is valid by checking the definition in the documentation.
**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 account for this SMS send. Please contact your account manager if you need more sending credits.
**ERROR_SURVEY_NOT_FOUND**
The survey you are trying to retrieve or reference in your call does not exist. Please make sure that the survey ID you are using is correct.
**ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE**
The API is temporarily down, most likely for scheduled maintenance, for which you should have received notification; if you did not please subscribe to our user warning list to be notified of these updates in future.
**ERROR_TRANSACTIONAL_DATA_COLLECTION_DOES_NOT_EXIST**
The transactional data collection you are trying to retrieve or reference in your call does not exist. Please make sure that the collection name you are using is correct.
**ERROR_TRANSACTIONAL_DATA_INVALID_COLLECTION_NAME**
The transactional data collection name you are trying to create isn't valid. Valid transactional data collection names can only contain alphanumeric characters (A-Z, a-z, 0-9), dashes ( - ) and underscores ( _ ), they can't start with a number and they can't exceed 255 characters in length. Please make sure that the collection name you are creating is valid.
**ERROR_TEMPLATE_INVALID**
The template is not valid. This means that there is something incorrect with the template object you are sending to the method/operation. Check that your template object is valid by checking the definition in the documentation.
**ERROR_TEMPLATE_NOT_FOUND**
The template object could not be found within the account. Either it has been deleted or it is likely that you are using the incorrect ID number.
**ERROR_THEME_INVALID**
You are attempting to set up an account with an invalid theme. Please check that the theme is correct.
**ERROR_TRANSACTIONAL_DATA_DOES_NOT_EXIST**
This piece of transactional data does not exist. Either it has been deleted or it is likely that you are using the incorrect collection name or key.
**ERROR_TRANSACTIONAL_DATA_STORAGE_ALLOWANCE_EXCEEDED**
You have exceeded your transactional data storage allowance.
**ERROR_TRANSACTIONAL_DATA_VALIDATION_FAILED**
The validation of the transactional data failed. This means that there is something incorrect with the transactional data object you are sending to the method/operation. Check that your transactional data object is valid by checking the definition in the documentation.
**ERROR_UNKNOWN**
We don't know what went wrong. Please contact our support department if you require assistance.
**ERROR_UNKNOWN_ACCOUNT**
The account is unknown. This means you are trying to reference an account that isn’t recognised. Please contact our support department if you require assistance.
**ERROR_USERACCOUNT_UNKNOWN**
This user account is not known. Please check the details you are using are valid.
**ERROR_WEAK_PASSWORD**
The password set for your API credentials is too weak.