Hevo uses conventional HTTP response codes to indicate the success or failure of an API request. The response codes available for an endpoint are listed in its detailed view. When you try out an endpoint, the response also mentions the associated code.

Use the following as a quick reference for understanding the API response:

Response Code Range	Description
2xx	The API request was successful.
4xx	There is an error in the request. For example, the request body is not formed correctly, or the API access token is invalid. The exact response code provides more detail.
5xx	There is a problem with Hevo’s servers. This is a rare occurrence. Contact Hevo Support if you get a response code in this range.

The following is the list of response codes based on the API method:

Method: GET

Success Response Codes

Status Code	Text	Description
200	Accepted	The request was successful and data has been returned.
204	No content	The request was successful, and there was no data to be returned.

Method: POST

Success Response Codes

Status Code	Text	Description
200	NA	A generic success response that contains some data in the response body.
201	Created	A new entity was created. The response body contains the newly created data.
204	No content	The action performed was successful, and there was no data to be returned.

Method: PUT

Success Response Codes

Status Code	Text	Description
200	Accepted	The data was successfully updated and relevant data was returned in response.
204	No content	The request was successful and no data was expected to be returned.

Method: DELETE

Success Response Codes

Status Code	Text	Description
204	No content	The entity was deleted successfully, or the entity was already deleted.

Method: All Methods

Error Response Codes

Status Code	Text	Description
400	Bad request	The request was unacceptable, often due to incorrect parameters or a missing required parameter.
401	Unauthorized	The API key and secret is not valid.
403	Forbidden	The user associated with the authenticating API key does not have permissions to perform the API request.
404	Not found	The requested resource does not exist.
500, 502, 503, 504	Server errors	Something went wrong at Hevo's end. (A rare occurrence!)

4xx and 5xx Error Response Attributes

Attribute	Data Type	Description
error_code	number	A unique code for an individual error type.
error_ticket	number	An optional identifier used by Hevo for logging.
error_message	string	A human-readable message providing details about the error.
success	boolean	An indicator specifying whether the request was successful or not. This is always false in case of failures.