COconvoy
carrierEligibility

Set or update carrier's eligibility to match a broker's loads on the Convoy Platform.

The api takes an array of Carrier Matching Eligibilities each with a DOT number and Eligibility Status. Carriers with a status of DO_NOT_USE will no longer be able to match to your loads on the Convoy platform. Carriers with QUALIFIED will be allowed to match. Carriers with a QUALIFIED status do not need to be explicitly sent, only if they have transitioned from a DO_NOT_USE status.

post/carrierEligibility

Request

  • Base URL
    https://demo-developer.convoy.com/broker
  • Auth
    HTTP bearer

Headers

X-Convoy-API-Versionstring required

The Convoy API version

Request body

Example request

{
  "matchingEligibilities": [
    {
      "dotNumber": "12345678",
      "status": "DO_NOT_USE"
    },
    {
      "dotNumber": "93578185",
      "status": "DO_NOT_USE"
    },
    {
      "dotNumber": "21349109",
      "status": "QUALIFIED"
    }
  ]
}

Response

Successfully set or updated all carrier eligibilities.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.