Errors

The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.

Code	Title	Description
200	OK	The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data.
201	Created	The request has been fulfilled and has resulted in one or more new resources being created.
204	No Content	The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
400	Bad Request	The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request.
401	Unauthorized	The request has not been applied because it lacks valid authentication credentials for the target resource.
402	Payment Required	Subscription data is incomplete or out of date. You'll need to provide payment details to continue.
403	Forbidden	You do not have the appropriate user rights to access the request. Do not repeat the request.
404	Not Found	The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
409	Conflict	The request could not be completed due to a conflict with the current state of the target resource.
422	Unprocessable Entity	The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.
429	Too Many Requests	You sent too many requests in a given amount of time ("rate limit"). Try again later.
5xx	Server Errors	Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue.

Handling errors

The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.

Error Types

MissingParamsError

Request is missing parameters from either path of body. Missing required params are described in the error detail of response.

MissingHeadersError

Request was made missing one of the required headers. Missing headers are described in the error detail of response. Check the documentation for the request you are making. One or more of the following will be required: x-apideck-app-id, x-apideck-consumer-id, x-apideck-service-id

SpecRequestValidationError

Input variables are not aligned with the open-api spec. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the the specification.

ConnectorExecutionError

A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. The downstream_errors may contain consolidated errors from the error response.

Here's a sample response:

{
  "status_code": 400,
  "error": "Bad Request",
  "type_name": "ConnectorExecutionError",
  "message": "Xero Connector Returned Error",
  "downstream_errors": [
    {
      "code": 100,
      "message": "Invoice # must be unique.",
      "detail": "The invoice number must be unique."
    }
  ],
  "detail": {
    "statusCode": 400,
    "context": {
      "connector": "Xero",
      "unified_api": "accounting",
      "resource": "invoices",
      "action": "add"
    },
    "error": {}
  },
  "ref": "https://developers.apideck.com/errors#connectorexecutionerror"
}

UnauthorizedError

We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sk_live_***'A user may disconnect your application by revoking access from within their connected platform UI. Your application should handle the "401 error" and allow the user to reconnect/reauthorize the integration quickly.

ConnectorCredentialsError

A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.

ConnectorDisabledError

A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.

ConnectorRateLimitError

You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.

RequestLimitError

You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately.

EntityNotFoundError

You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.

CredentialsNotFoundError

When adding a connector integration that implement OAuth, both a client_id and client_secret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.

IntegrationNotFoundError

The requested connector integration could not be found associated to your application_id. Verify your application_id is correct, and that this connector has been added and configured for your application.

ConnectionNotFoundError

A valid connection could not be found associated to your application_id. Something may have interrupted the authorization flow. You may need to start the connector authorization process again.

ConnectorNotFoundError

A request was made for an unknown connector. Verify your service_id is spelled correctly, and that this connector is enabled for your provided unified_api.

RedirectUriError

A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process.

InvalidStateError

The state param is required and is used to ensure the outgoing authorization state has not been altered before user id redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.

AuthCodeExchangeError

When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.

MappingError

There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.

ConnectorMappingNotFoundError

It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorResponseMappingNotFoundError

We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorOperationMappingNotFoundError

Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorWorkflowMappingError

The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.