API reference: Return codes documents the function signatures, parameters, return values, and error behavior of the Elaine HTTP API.
Note
Function availability depends on the Elaine release and enabled features. Authenticate HTTP requests with an Elaine-issued Bearer JWT.
General
| Name | Value | Description |
|---|---|---|
ELAINE_ERROR_QUERY | -1 | The database action could not be triggered. |
ELAINE_ERROR_NOCLIENT | -2 | API not initialised for a tenant. |
ELAINE_ERROR_NOEMAIL | -3 | A data set without email address and alternative key was given. |
ELAINE_ERROR_EXISTS | -5 | There has been an attempt to create an existing user, e.g. a user with already existing email address. |
ELAINE_ERROR_NOVALUES | -6 | It was given no or an empty array. |
ELAINE_ERROR_NOTEXISTS | -7 | No recipient profile was found with the given ID. |
ELAINE_ERROR_NOGROUP | -8 | It was not given a recipient group ID. |
ELAINE_ERROR_INVALIDGROUP | -9 | No recipient group was found with the given ID. |
ELAINE_ERROR_NO_ID | -10 | It was not given a recipient profile ID. |
ELAINE_ERROR_NOHASH | -11 | It was not given a recipient profile hash. |
ELAINE_ERROR_INVALID_EMAIL | -12 | The given email address is invalid. |
ELAINE_ERROR_MODULE_MISSING | -13 | The accessed module or feature is not activated |
ELAINE_ERROR_USER_BLACKLISTED | -14 | The given recipient profile is on the blacklist. |
ELAINE_ERROR_USER_BOUNCED | -15 | The given recipient profile is on the bounce list. |
ELAINE_ERROR_INVALID_CLIENT | -16 | The given mailing does not belong to the tenant, with which the API has been initialized. |
ELAINE_ERROR_METHOD_NOT_ALLOWED | -17 | The execution of the function is not allowed. Either the function is deprecated or not activated. |
ELAINE_ERROR_INVALID_INPUT | -18 | The function was called with invalid parameters. |
ELAINE_ERROR_NO_VALUE_FOR_KEY | -19 | In the given array the current key is not set. |
ELAINE_ERROR_CONFIGURATION | -20 | Processing has been cancelled due to an error in the configuration of the Elaine instance. |
ELAINE_ERROR_GENERAL | -21 | Processing was cancelled due to a general error. |
ELAINE_ERROR_DATABASE_BLOCKED | -22 | Processing was cancelled due to temporary blocked database. |
ELAINE_ERROR_BULK_VALIDATION | -55 | Bulk: The data block could not be processed due to validation errors |
ELAINE_ERROR_BULK_BLOCK_INVALID | -56 | Bulk: The entire data block could not be processed due to an content error. |
Marketing Automation
| Name | Value | Description |
|---|---|---|
ELAINE_ERROR_CAMPAIGN_NOCAMPAIGN | -50 | The given ID does not match a marketing automation campaign. |
ELAINE_ERROR_CAMPAIGN_NOSUBSCRIBE | -51 | The registration of a recipient profile to a marketing automation campaign could not be successfully completed. |
ELAINE_ERROR_CAMPAIGN_CLOSED | -52 | The marketing automation campaign has the status "closed". Therefore registrations are no longer possible. |
ELAINE_ERROR_CAMPAIGN_INACTIVE | -53 | The marketing automation campaign has the status "inactive". Therefore registrations are not possible. |
ELAINE_ERROR_CAMPAIGN_STAGING | -54 | The marketing automation campaign has the status "staging/test". Therefore registrations are not possible. |