Mailbox API – Error Handling | Axigen Documentation

The Mailbox API is available starting with Axigen X4 (10.4).

Intro
Generic Errors
Endpoint-specific Errors

Intro

In case of errors, all the Native API endpoints will respond with an appropriate HTTP error status codes and a top-level JSON object in the body containing details about the encountered error.

The JSON body will contain the following fields:

Generic Errors

Endpoints	Error Code	HTTP Status Code	Notes
All endpoints requiring login	`UNAUTHORIZED`	401 Unauthorized	The user needs to authenticate before accessing the endpoint.
All endpoints requiring a premium license	`NOT_PREMIUM`	403 Forbidden
All endpoints	`BAD_PARAMETER`	400 Bad Request	A parameter is invalid, required but missing, or unexpected
All endpoints returning a single resource	`RES_NOT_FOUND`	404 Not Found	Requested resource was not found
All endpoints	`ENDPOINT_FAILED`	500 Internal Server Error	The server has encountered an internal error while executing the requested endpoint
Unexpected	`UNKNOWN`	500 Internal Server Error	Default error, should not be part of the API

Endpoint-specific Errors

Folders

Endpoints	Error Code	HTTP Status Code	Notes
Move / Delete / Rename	`INVALID_OPERATION`	403 Forbidden	Operation not permitted.
Move / Delete / Rename / Copy / Create	`PATH_TOO_LONG`	400 Bad Request	The chosen folder name is too long.
Move / Delete / Copy / Create	`HIERARCHY_TOO_LONG`	403 Forbidden	The parent folder is not allowed to have subfolders.
Copy / Create	`COUNT_QUOTA_EXCEEDED`	403 Forbidden	The message count quota for the account or targeted folder is reached.
Move / Delete / Rename / Copy / Create	`DUPLICATE_NAME`	409 Conflict	Naming conflict

Mails

Endpoints	Error Code	HTTP Status Code	Notes
Search	`BAD_PARAMETER`	400 Bad Request	The supplied mail search query was missing or invalid.
Send / Send Draft	`SEND_RATE_EXCEEDED`	429 Too Many Requests	The mail send rate limitation is reached.
Send / Send Draft	`SIZE_LIMIT_EXCEEDED`	400 Bad Request	The size of the email exceeds the allowed limit.
Send / Send Draft	`RCPTS_LIMIT_EXCEEDED`	400 Bad Request	The number of recipients for the current email exceeds the allowed limit.
Send / Send Draft	`ATT_SIZE_LIMIT_EXCEEDED`	400 Bad Request	At least one for the attachments' size exceeds the allowed limit.
Send / Send Draft	`ATT_COUNT_LIMIT_EXCEEDED`	400 Bad Request	The number of attachments exceeds the allowed limit.
Create / Send / Send Draft / Replace Draft / Copy	`DISK_QUOTA_EXCEEDED`	403 Forbidden	The disk quota for the account or targeted folder is reached.
Create / Send / Send Draft/ Replace Draft / Copy	`COUNT_QUOTA_EXCEEDED`	403 Forbidden	The message count quota for the account or targeted folder is reached.

Temporary Attachments

Endpoints	Error Code	HTTP Status Code	Notes
Create / Store	`PAYLOAD_TOO_LARGE`	413 Payload Too Large	The supplied attachment exceeds the attachment size limit

Account - Signature

Endpoints	Error Code	HTTP Status Code	Notes
Create	`COUNT_QUOTA_EXCEEDED`	403 Forbidden	Signature limit is reached

Account - Temporary Alias

Endpoints	Error Code	HTTP Status Code	Notes
Create	`COUNT_QUOTA_EXCEEDED`	403 Forbidden	Temporary aliases limit is reached

Account - Filters Whitelist and Blacklist

Endpoints	Error Code	HTTP Status Code	Notes
Create	`COUNT_QUOTA_EXCEEDED`	403 Forbidden	Filters limit is reached
Create/Update	`DUPLICATE_NAME`	409 Conflict	Naming conflict

Conversations

Endpoints	Error Code	HTTP Status Code	Notes
List	`FOLDER_INVALID`	403 Forbidden	Folder does not support conversations
Delete	`DISK_QUOTA_EXCEEDED`	403 Forbidden	The disk quota for the account or targeted folder is reached.
Delete	`COUNT_QUOTA_EXCEEDED`	403 Forbidden	The message count quota for the account or targeted folder is reached.
Move	`FORBIDDEN`	403 Forbidden	Operation not permitted on standard folders.

Labels

Endpoints	Error Code	HTTP Status Code	Notes
Create / Update	`NAME_TOO_LONG`	400 Bad Request	The chosen name is too long.
Create / Update	`DUPLICATE_NAME`	409 Conflict	Naming conflict