API Errors

The Postman v2 API 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 a request that failed given the information provided (e.g., a required parameter was omitted, not having access to the campaign due to wrong API key, etc.). Codes in the 5xx range indicate an error with Postmanโ€™s servers (these will be rare).

Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

Attributes


message string

A human-readable message providing more details about the error.


statusCode number

The HTTP status code of the error.


HTTP status code summary

Status code
What it means

200 - OK

Everything worked as expected - you will get this status code for successful GET requests.

201 - Created

Everything worked as expected - your message(s) is/are created in our system. You will get this status code for successful POST requests that lead to the creation of messages.

400 - Bad Request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

No valid API key provided.

403 - Forbidden

404 - Not Found

The requested resource doesn't exist.

429 - Too Many Requests

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500, 502, 503, 504 - Server Errors

Something went wrong on Postmanโ€™s end. (These will be rare.)

Last updated