Waiting for engine...
Skip to main content

Boomi API errors

The Boomi Enterprise Platform API and the Partner API return standard HTTP status codes or SOAP fault codes to indicate the success or failure of an API request.

provides standard HTTP status codes and clear messaging to help you identify and correct potential errors with your API call. Boomi Enterprise Platform API and Partner APIs return the following potential error statuses.

2xx Success​

The Boomi Enterprise Platform API or Partner API returns 200-type statuses when the call is successful. However, some success statuses can also indicate additional complications that you must address:

  • 200—The request is successful.
  • 202— The request did not finish processing and requires more wait time. Clients typically encounter this status in the context of asynchronous APIs.
  • 204— There is a successful exchange between client and server, but there is no content or data at the requested URL. For example, the client encounters a 204 code in the second half of an asynchronous API after retrieving the content successfully or deleting the content automatically after 30 minutes.

4xx Client request issues​

The Boomi Enterprise Platform API or Partner API returns 400-type statuses when the client does not correct authentication or permissions to complete the call. The following list describes the various 400-type statuses one may receive.

  • 400: Bad Request— The server was unable to proceed with the request, usually because the request format or data is invalid. Ensure the request body and parameters match the API schema and required types before retrying.

    Common examples include:

    • <property> does not exist
    • Accounts cannot be deleted with the UPDATE action
    • An error occurred as a result of invalid input
    • An error occurred as a result of missing credentials or unauthorized access
    • API limit must be set through non-incremental update first

    How to fix these?

    Fix the request format and values to match the API schema; resend with valid data.

  • 403— The API made the request using incorrect or partial authentication credentials. If you encounter a 403 error, check that you have correct permissions and authorized access to the account specified in the API endpoint. Additionally, ensure that the authorization credentials supplied in the API tool are valid.

  • 404— Made a call to an API endpoint that does not exist. Ensure that the endpoint URL points to a valid API or that there is a properly formed request body.

  • 410— The API is retired or the specified Atom is currently offline.

5xx Service Unavailable​

The Boomi Enterprise Platform API or Boomi Partner API returns 500-type statuses when the API cannot complete the call due to a service interruption. The following list describes the various 500-type statuses one may receive.

  • 503— The server is too busy or the client exceeded the allotted rate limit. Have the client try again later.
  • 504— The client cannot reach the Atom or the server at this time. Have the client try again later.

Sample response​

For errors encountered during a REST request, an error message is returned along with the appropriate HTTP status code. The following is an example error message for which the HTTP status code is either 400 (indicating an error with the clients request) or 500 (indicating a server error).

<error>
    <message>ERROR_MESSAGE</message></error>
On this Page