Status codes
| Code | Meaning |
|---|---|
200 | Success. The request completed as expected. |
400 | Bad request. The request body is malformed or missing required fields. |
401 | Unauthorized. The x-token header is missing or the API key is invalid. |
403 | Forbidden. The API key does not have permission to access this resource. |
404 | Not found. The board ID, card ID, or contact ID does not exist. |
429 | Too many requests. You have exceeded the rate limit. |
500 | Internal server error. Something went wrong on the Aptly side. |
Frequent errors
Missing x-token header
Be sure to include the header x-token: YOUR_API_KEY on every request.
x-token header.
Wrong API key for the board
Each board generates its own API key. Using a key from one board against a different board’s endpoint will fail.Board ID does not exist
The board ID in the URL does not match any board associated with your API key.Malformed request body
The request body could not be parsed as valid JSON, or theContent-Type header is missing.
-H "Content-Type: application/json" and that the body is valid JSON. Run your payload through a JSON validator if you are unsure.
