---
title: "Create a new broker integration"
method: POST
path: "/integration/createBrokerIntegration"
tags: ["integration"]
---

# Create a new broker integration

`POST /integration/createBrokerIntegration`

## Request

- Base URL: `https://demo-developer.convoy.com/broker`
- URL: `https://demo-developer.convoy.com/broker/integration/createBrokerIntegration`
- Auth: HTTP bearer

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.

## Headers

- `X-Convoy-API-Version` string, required

## Request body

- BrokerIntegrationCreateBrokerIntegrationRequest: Create a new broker integration request.
  - `integratorBrokerId` string, required: Integrator id for the broker
  - `requestMetadata` BrokerIntegrationBrokerIntegrationRequestMetadata: Metadata about the broker integration request
    - `broker` BrokerIntegrationBrokerMetadata: External identifiers for the broker, this could include state and federal broker numbers
      - `dotNumber` string: The US DOT number of the broker
      - `mcNumber` string: The MC number of the broker
      - `createdAt` string, date-time: The date the broker was created in the integrator
      - `loadCount` integer: The number of loads the broker has completed with the integrator
    - `requestor` BrokerIntegrationRequestorMetadata
      - `fullName` string: The full name of the integration requester
      - `email` string: The email address of the integration requester
      - `phoneNumber` string: The phone number of the integration requester

## Response `200`

The request has succeeded.

- BrokerIntegrationCreateBrokerIntegrationResponse: The response body for the create broker integration request.
  - `code` string, required: The code the requestor will use to set up their integration.

## Other responses

- `400`: Invalid request. Failed to create a new broker integration request.
- `default`: Unexpected error.

---

[API](https://skmtc.dev/convoy/apis/brokers.md) - [All operations](https://skmtc.dev/convoy/apis/brokers/llms.txt) - [OpenAPI document](https://skmtc.dev/convoy/apis/brokers/revisions/a43e2868b355?raw)
