When you make a request to the Document360 API, the server responds with an HTTP status code. This code indicates whether the request succeeded or failed, and guides how your application should handle the response.
Each response is also accompanied by a structured JSON body that includes fields such as success, errors, and error_code. Use both the status code and JSON body for effective error handling and debugging.
Common HTTP Status Codes
The following table lists the most frequently returned status codes by the Document360 API:
Status Code | Name | Description |
|---|---|---|
200 | OK | Request fulfilled successfully |
201 | Created | New resource created |
400 | Bad Request | Invalid or malformed request |
401 | Unauthorized | Missing or invalid API token |
403 | Forbidden | Authenticated, but the client does not have permission |
404 | Not Found | The requested resource was not found |
429 | Too Many Requests | Rate limit has been exceeded |
500 | Internal Server Error | The server encountered an unexpected error |
503 | Service Unavailable | Service temporarily unavailable due to maintenance |
You can use these status codes in your integration logic to trigger retries, display user-friendly messages, or log errors for further investigation.
Each API response also includes a JSON body with a success field and, if applicable, an errors array describing the issue in more detail.
Handling HTTP status codes
To build integrations with the Document360 API, consider the following best practices for handling common status codes:
2xx (Success)
200 OK: Process the returned
datafrom the JSON body.201 Created: Store the resource identifier for future reference.
400 Bad Request
Check for issues in the request body or query parameters.
Review the
errorsarray in the JSON response for specific error details.Use the
error_codefield to implement programmatic handling.
401 Unauthorized / 403 Forbidden
Validate that your
api_tokenis included and correct.If using a token with limited scope, confirm that it includes access to the requested resource.
For role-based access issues, review the user or project permissions.
404 Not Found
Verify that the resource ID or endpoint is correct.
Ensure the resource has not been deleted or moved.
429 Too Many Requests
Implement rate limit awareness in your client.
Check for a
Retry-Afterheader and use exponential backoff before retrying.
5xx Server Errors (500, 503)
These indicate temporary issues on the server.
Retry after a short delay with exponential backoff.
Notify your development or support team if errors persist.
PRO TIP
Always log failed responses along with the
error_code,description, and request details to help with debugging and support.