Only show these results:

API responses, errors, and HTTP status codes

Nylas uses conventional HTTP response codes to indicate the success or failure of an API request.

The v2-specific section on Mail Sync States has moved.

Status Codes

Status Code Description
200 OK Everything worked as expected.
202 Not Ready The request was valid, but the resource wasn't ready. Retry the request with an exponential backoff.
400 Bad Request The request is malformed or missing a required parameter.
401 Unauthorized Could not verify access credential. No valid API key or access_token was provided.
402 Request Failed or Payment Required The request parameters were valid, but the request failed. Or, a credit card must be added to your organization.
403 Forbidden The request includes authentication errors, blocked developer applications, and cancelled accounts.
404 Not Found The requested item doesn't exist.
405 Method Not Allowed You tried to access a resource with an invalid method.
410 Gone The requested resource has been removed from our servers.
413 Request Entity Too Large Transmitted data value exceeds capacity limit for Send and Files requests.
418 I'm a teapot. 🫖
422 Sending Error This response returned during the sending process.
429 Too Many Requests Slow down! If you legitimately require this many requests, please contact support.
500, 502, 503 Server errors An error occurred in the Nylas server. If this persists, see our status page or contact support.
504 Provider Error Please wait and try again. If the problem persists, check with your service provider.

Empty PUT Request

Sending a PUT request with an empty body will result in a 400 error Empty request body.

View a full list of possible codes on the List of HTTP Status Codes on Wikipedia or the HTTP Status Codes database.

Error bodies include a JSON object with a standard set of attributes, including an error type and a human-readable message string. These are designed to make debugging easier and allow for different handling of scenarios, that produce the same HTTP status code.

Error Type Details
api_error A general API error occurred.
invalid_request_error The request has an invalid format.
provider_error An error with the underlying account's provider has occurred.

Error Statuses