Error Handling

Error codes and resolutions

SmartRecruiters uses conventional HTTP response code to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success, code in the 3xx range indicates additional action may need to be taken by the user agent, code in the 4xx range indicate an error and (rarely) codes in the 5xx range indicate an error within SmartRecruiters server.

HTTP Status Code Summary

Code

Description

200 - OK

Everything worked as expected

201 - Created

The resource was successfully created

204 - No Content

The request was successful and there is no content to be returned

304 - Not Modified

The request was successful but the response has not been modified

400 - Bad Request

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

401 - Unauthorized

No valid API credential provided

403 - Forbidden

The API credential doesn't have the access right to perform the request.

404 - Not Found

The request resource doesn't exist

409 - Conflict

The request conflicts with a different request

422 - Unprocesable Entity

The semantic of the request is incorrect

429 - Too Many Requests

Too many requests hit the API too quickly

500, 502, 503, 504 - Server Errors

Something is not right on SmartRecruiters' side