All API requests return both as HTTP status code and a response object. Please check the response object for errors and retry the API requests if an error has been hit.
Validation error
When you encounter a validation error please check the result_data.error array for the causes and resolve it by updating the posted data accordingly and resubmitting the API request.
Example validation error:
{
"success": false,
"result_data": {
"errors": [
"'create_time' is not a valid date"
]
},
"result_text": "Validation failed, see 'result_data' -> 'errors'"
}
Rate limit error
This error means you are sending API requests too fast. Resolve it by sending fewer concurrent API requests so you are under your account's per second rate limit.
You may check the rate limit on the 'Integrations' tab on the account options page. Your account limits are also returned in the rate limit error message.
Example per second rate limit error:
{
"success": false,
"result_data": {
"exceeded": "second",
"limits": {
"day": {
"limit": 1000,
"current_usage": 55
},
"second": {
"limit": 3,
"current_usage": 4
}
}
},
"result_text": "Per second API limit of 3 exceeded."
}
Daily limit error
This error means you have exceeded your account's daily API requests. Resolve it by sending fewer requests per day or contact support to increase your daily API count.
You may check the daily limit on the 'Integrations' tab on the account options page. Your daily account limits are also returned in the limit error message.
IMPORTANT: Your account administrator will get a warning email when the daily limit has reached 80% of the total, and another email when the limit has been exceeded. Once the daily limit has been exceeded all further API calls will fail. It's important that you check for this error result in your code, and manage around it.
Tip: Sometimes you can restructure your API logic to reduce the total API calls. Try using the 'upsert' parameter with a Contact insert to reduce your insert and update call logic to one request instead of two.
Example daily limit error:
{
"success": false,
"result_data": {
"exceeded": "day",
"limits": {
"day": {
"limit": 1000,
"current_usage": 1001
},
"second": {
"limit": 3,
"current_usage": 0
}
}
},
"result_text": "Daily API limit of 1000 exceeded."
}