HTTP Errors

Our APIs use HTTP response codes to indicate the success or failure of an API request.

Status Codes

Code

Type

Description

200

Success

OK

201

Success

Created

204

Success

No Content

304

Redirection

Not Modified

400

Client Error

Bad Request

401

Client Error

Unauthorized

403

Client Error

Forbidden

404

Client Error

Not Found

409

Client Error

Conflict

429

Client Error

Too Many Requests

500

Server Error

Internal Server Error

In the case of an error code, the response body will indicate further details to help troubleshoot the error.

{
    "error": {
        "title": "ValidationError",
        "message": "campaign_id parameter is required" 
    }
}

Rate Limiting

To prevent misuse, our API endpoints implement rate limiting. If your application exceeds this limit then a HTTP 429 "Too Many Requests" response code will be returned.

HTTP headers are returned on all endpoints which contain how many more requests your application is allowed.

Header

Description

x-rate-limit-limit

The rate limit for a given endpoint

x-rate-limit-remaining

The number of requests remaining

x-rate-limit-reset

The time at which the rate limit resets

If you require a rate limit increase, please reach out to support@heypoplar.com

Last updated