Skip to main content
POST

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId
string<uuid>
required

Company identifier

Body

application/json
brokerageId
string<uuid>
required

ID of an existing brokerage this broker belongs to. Use GET /brokerages to find valid IDs, or POST /brokerages to create one first.

name
string
required

Broker name (required)

email
string<email>

Broker email address

defaultCommissionPercentage
number

Default commission percentage (0-100)

Required range: 0 <= x <= 100
addressStructured
object

Structured address information

phone
string

Primary phone number

workPhone
string

Work phone number

producerNumber
string

Producer number/identifier

Response

Broker created successfully

id
string<uuid>

The ID of the created broker