API error responses

API overview

This resource provides an overview of error responses that can be received when making API requests for your custom API data sources.

NOTE:

  • These error responses refer to API errors that may be received when making requests for your account's API data source.
  • For help with any API errors that you may see in-app, please contact our support team for further assistance.

Accessing API data source responses

All requests made to Ortto's API will return a response to the source of the initial call.

In addition to this, recent calls are also recorded in the logging for the data source. You can access recent API calls in-app from the Logs view.

To do so, you can select More > Data Sources > [Your data source name] Custom API > Logs

Example of the Logs view for API data sources




Status Codes

Ortto's API adheres to widely accepted HTTP status codes to indicate the outcome of API requests.

These table provides an overview of common status code errors that may be received. Please note that error messages and descriptions that you receive may provide different responses that are specific to the error encountered in that call.

HTTP Status Code

Error Message

Description

Notes

400

Bad Request

The request could not be understood or was missing required parameters.



401

Unauthorized

Authentication failed or user does not have permissions for the requested operation.

This may occur if using the incorrect API key or incorrect X-API-Key header.

403

Forbidden

Authentication succeeded, but the authenticated user does not have access to the resource.

This may occur if the account being called upon has been expired or the user that authorized the key is no longer on the account.

404

Unknown endpoint or method

The requested resource could not be found.

This may occur if making a call without the necessary call body information present.

405

Method Not Allowed

The requested method is not supported for the specified resource.



406

Not Acceptable

The server cannot produce a response matching the list of acceptable values defined in the request's headers



408

Request Timeout

The server timed out waiting for the request.



409

Conflict

The request could not be completed due to a conflict with the current state of the resource.

This may occur if attempting to create a custom field with the same name as a previously deleted custom field. For assistance with this, please contact our support team.

410

Gone

The requested resource is no longer available at the server.

This may occur if attempting to update a field that has been previously deleted from the account.

429

Too Many Requests

Too many requests were sent in a given amount of time. Rate limiting has been applied.

For more information regarding rate limits, please see our Rate Limit resource here.

500

Internal Server Error

The server has encountered an unexpected error.



501

Not Implemented

The request method is not supported by the server and cannot be handled.



502

Bad Gateway

The server, while acting as a gateway or proxy, received an invalid response from the upstream server.



503

Service Unavailable

The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded.



504

Gateway Timeout

The server did not receive a timely response from the upstream server



507

Insufficient Storage

The server is unable to store the representation needed to complete the request.

This may occur if attempting to include additional contacts to an organization beyond the account's supported limits.