API v1.0 Errors & Exceptions
The system returns errors and exceptions based on the codes in the following table. When an error is returned you will
receive a keyed array with a status code and message. If you are using a wrapper, this will be handled for you. If not you
must parse the error response yourself. The response will be in the following format:The API will return an error response whenever possible. Your system can gracefully handle these errors instead of crashing. You should always check for an error response and handle it appropriately.
Error & Exception Codes
| Code | Explanation |
|---|---|
| 1 | E_CONNECT: The client wrapper is unable to connect to the API service. Reserved by client wrappers. |
| 2 | E_RESPONSE: The client wrapper received an unexpected and unparsable response. Reserved by client wrappers. |
| 3 | E_TIMEOUT: The socket timed out sending or waiting for a response. Increase the timeout value. Reserved by client wrappers. |
| 4 | E_UNKNOWN: An unknown error was encountered. Oops. Reserved by client wrappers. |
| 50 | E_CAMPGN_FAILED: A general campaign related failure occurred. Retry. |
| 51 | E_CAMPGN_404: The requested campaign could not be found. Check the id and try again. |
| 52 | E_CAMPGN_CREATE: The system failed to create the campaign. |
| 53 | E_CAMPGN_COPY: The system failed to copy the campaign. |
| 54 | E_CAMPGN_SCHEDULE: The system failed to schedule the campaign. |
| 55 | E_CAMPGN_NO_TARGET: There system failed to find any recipients for the mailing. |
| 56 | E_CAMPGN_QUOTA: The account quota would be exceed if the mailing is scheduled. |
| 150 | E_LIST_FAILED: A general list related failure occurred. Retry. |
| 151 | E_LIST_404: The requested list could not be found. Check the id and try again. |
| 152 | E_LIST_EXISTS: A list with that name already exists. |
| 250 | E_SUB_FAILED: A general subscriber related failure occurred. Retry. |
| 251 | E_SUB_404: The requested subscriber could not be found. Check the id_or_email and try again. |
| 350 | E_KEY_FAILED: A general API key related failure occurred. Retry. |
| 351 | E_KEY_404: The requested API key could not be found. Check the id_or_key and try again. |
| 352 | E_KEY_EXPIRED: The requested API key is marked as expired (disabled). |
| 450 | E_ENT_NOT_MASTER: The Agency account you supplied is not a master account. |
| 451 | E_ENT_LINK_FAILED: Failed linking a sub-account to an Agency master account. |
| 452 | E_ENT_CREATE_FAILED: Failed creating an Agency sub-account. |
| 453 | E_ENT_STATUS_EXISTS: The Agency sub-account you are enabling is already enabled. |
| 454 | E_ENT_STATUS_ERROR: General status update failure. |
| 500 | E_EXCEPTION: The system generated an exception. See the status message provided for details. |
| 501 | E_LOCKOUT: The system is currently unavailable. Details may be provided in the status message. |
| 502 | E_INVALID_METHOD: You tried to invoke a method that does not exist. Check the method name you are providing and try again. |
| 503 | E_INVALID_PARAMS: You have not provided all of the required parameters to the method you are invoking. Check the documentation and try again. |
| 504 | E_INVALID_PAGE: The paging parameter you have provided is not valid given the limit. |
| 505 | E_INVALID_LIMIT: The limit you have provided is invalid and we could not generate an otherwise valid value. |
| 506 | E_WRONG_ORDER: You've made a request out of order. Some other specified event must occur first. |
| 507 | E_AUTH_FAILED: The credentials you supplied could not be authenticated. |
| 508 | E_ACCOUNT_INACTIVE: The account you are authenticating is no longer active. |
| -1 | E_TEST: A sample error code. Reserved. |