We use conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with our servers.
Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.
Attributes
code string
A short string indicating the error code reported.
message string
A human-readable message providing more details about the error.
errors string[]
A list of reasons that caused the error.
Codes
CODE_ALREADY_EXISTS
A object with a code already exists. Use a different, unique value for code and try again.
OBJECT_NOT_FOUND
The requested object doesn't exist.
INVALID_BODY
The request was unacceptable, often due to missing a required parameter.
INTERNAL_ERROR
Something went wrong on our end.
Example
{
"code": "CODE_ALREADY_EXISTS",
"message": "The recipient (5a3d6dbb-4ee1-4633-9088-9de8901eef5e) already exists.",
"errors": []
}