COconvoy
integration

Create a new broker integration

Create a new broker integration. Integrations for existing, active Convoy brokers will be subject to approval by the broker's administrator. Integrations for new or existing inactive brokers will be subject to a broker onboarding and verification process.

post/integration/createBrokerIntegration

Request

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

Headers

X-Convoy-API-Versionstring required

The Convoy API version

Request body

integratorBrokerIdstring required

Integrator id for the broker

Example request

{
  "requestMetadata": {
    "broker": {
      "dotNumber": "USDOT1234567",
      "mcNumber": "MC1234567"
    },
    "requestor": {
      "email": "test@example.com",
      "phoneNumber": "+10123456789"
    }
  }
}

Response

The request has succeeded.

codestring required

The code the requestor will use to set up their integration.

Example response

{
  "code": "dYvFMBFWcgPUjzmGxnMJUfEl"
}

Changes

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