Errors

The Flowroute API returns both an HTTP Status Code and a JSON body with each error. The status in the error will match the HTTP Status Code that is returned and the title and detail fields will give more context to the error. You can give the id to Flowroute Support and they will be able to retrieve details about the error from our logs.

Error Fields

  • detail
    string

    An expanded explanation of why your API request was unsuccessful.

  • id
    UUID

    Unique identifier associated with the API request that generated the error.

  • status
    integer

    HTTP Status code related to the error.

  • title
    string

    HTTP Short description of what error was encountered.

Error Codes

  • 400

    Bad Request – Some aspect of the request was unprocessable.

  • 401

    Unauthorized – There was an issue with your API credentials.

  • 403

    Forbidden – You don't have permission to access this resource.

  • 404

    Not Found – The specified resource does not exist.

  • 405

    Method Not Allowed – You tried to use an unsupported HTTP method.

  • 422

    Unprocessable Entity – You tried to enter an incorrect value.

  • 429

    Too Many Requests – You have sent too many requests at a given time and need to slow down how often you’re querying the API.

  • 500

    Internal Server Error – We had a problem with our server. Try again later.

  • 503

    Service Unavailable – We’re temporarially offline for maintanance. Please try again later.

            

Example Request

curl https://api.flowroute.com/v2/portorders/portability \
  12345678:33333444AA \
  -X POST \
  -H "Content-Type: application/json" \
  -d {"numbers": ["12065555555","18444205780","15552348976"]}

            

Example Response

{
  "errors": [
    {
      "detail": "Authentication failed.",
      "id": "31e1d9d3-3033-479a-84b1-7e0e77e29f94",
      "status": 401,
      "title": "Unauthorized"
    }
  ]
}