Mailstand's API uses conventional HTTP response codes to indicate the success or failure of an API request. In case of error, the API returns an array of errors containing information regarding what happened.
Error Code Format Example
{
statusCode: 400,
error: "Missing Fields",
message: "Your request is missing the following keys: referred_by"
}
Common Error Labels
| Code | |
|---|---|
| Bad Request | General error system (400 or 500) |
| Missing Fields | The request is missing key information to process the request (400) |
| Failed Validation | The request failed a basic validation needed (400) |
| API Connection Error | The request was unacceptable, often due to missing a required parameter. (401) |
| Invalid Request | When a request fails based on input (example: verification code is wrong on input) (400) |
| Unauthorized Permission | No valid API key was provided. (401) |
| Missing Record | We could not find the record that you're searching for/deleting (400) |
| Too Many Requests | Your account does not have enough credits to perform this action. You can upgrade within the platform. (429) |
| Rate Limited | You are sending too many requests at once. Please try again soon and/or adjust the speed of your requests. (429) |