Errors

Mailosaur uses HTTP response codes to indicate the success or failure of an API request. We recommend writing code that can handle these different scenarios.

HTTP Status Codes

Mailosaur uses 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), and codes in the 5xx range indicate an error with Mailosaur’s servers (give us a shout in the unlikely event that you see one of those).

CodeDescription
200 OKRequest was successful.
204 No ContentRequest was successful, no response content.
400 Bad RequestThe request could not be handled, often due to missing a required parameter.
401 UnauthorizedNo valid API key provided.
404 Not FoundThe requested resource doesn’t exist.
5XX Server ErrorsSomething went wrong at Mailosaur. (Give us a shout).

Error handling

In case of an error the server will return as much information as possible. In the case of a 401 or 404 error the status code gives as much information as you’d need. But for 400 errors Mailosaur will return a JSON object containing the structure below.

Note that our client libraries convert responses to appropriate language-specific objects.

FieldDescription
typeThe type of error returned.
messageA human-readable message providing more details about the error.
parametersA JSON object containing a key for each property name at fault, with a human-readable message per field.
modelThe request model that was sent and failed to be processed.