Response Codes
This section lists the HTTP status codes that the API can return and explains what each one indicates about the processing status of the request:
The colored symbols below in green represent the good (OK) status codes and in red for the bad (Error) status codes.
HTTP Status Code | Reason | Detailed Explanations |
---|---|---|
✅200 | OK | This is the standard response for successful HTTP requests. The actual response will depend on the request method used. This will apply to GET, PATCH, DELETE, and PUT requests. |
✅201 | OK | This is the standard response for successful HTTP requests. The actual response will depend on the request method used. In a POST request, the response will contain an entity describing or containing the result of the action. This code will only apply to POST requests. |
✅204 | OK | This is if there is no response for a successful request. |
🛑401 | Unauthorized | The request requires user authentication. Invalid credentials were provided, the token has expired, or the user doesn’t have permission to perform the requested operation. |
🛑403 | Forbidden | The server understood the request, but is refusing to fulfill it. Authorization doesn’t help here. |
🛑404 | Not Found | The server has not found anything matching the requested URI (Endpoint). This could be a wrong URL or the resource doesn’t exist. |
Updated 9 months ago