Response codes
The DreamApply API uses standard HTTP status codes to communicate the results of API requests. The codes below outline the general logic of status codes across the system. For more specific code meanings for individual API requests, see the API reference.
Success
| Code | Description |
|---|---|
200 OK | The generic success code. |
201 Created | A typical response for the POST request. A new resource was created, and the response includes a reference to the created resource. |
204 No Content | A typical response for PUT and DELETE requests. The response was completed, but there is no response body. |
Error
| Code | Description |
|---|---|
400 Bad Request | The request parameters or body fail validation, for example, the ID is not in the correct format or some of the filtering parameters are invalid. |
401 Unauthorized | The request authentication failed; the DreamApply API key is missing, expired or invalid. For details, see Authentication and security. |
404 Not Found | A requested resource cannot be found. Typically indicates that the resource (generally identified by its ID) does not exist. If you issue multiple DELETE requests for the same resource, you will receive this error on any subsequent requests. |
409 Conflict | A request cannot be completed due to a conflict, for example, a flag or tracker with the same ID already exists or an applicant with the same email address is already registered. |
429 Too Many Requests | Too many requests were sent in a short period of time. For details, see API quota limits. |
500 Internal Server Error | The server has encountered an error while processing the request. The issue is not caused by the client, and the client may retry the request. If the error persists for the same request, contact the DreamApply team with the request details. |