curl --request POST \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/brokers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"brokerageId": "770e8400-e29b-41d4-a716-446655440000",
"name": "John Smith"
}
'
{
"id": "550e8400-e29b-41d4-a716-446655440003"
}
Brokers
Create Broker
Creates a new broker associated with an existing brokerage.
Required fields:
brokerageId- ID of an existing brokerage (use GET /brokerages to find valid IDs)name- Broker name
Optional fields:
email- Broker email addressdefaultCommissionPercentage- Default commission percentage (0-100)addressStructured- Structured address objectphone- Primary phone numberworkPhone- Work phone numberproducerNumber- Producer number/identifier
Required permission: company.broker:create
POST
/
api
/
external
/
companies
/
{companyId}
/
brokers
curl --request POST \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/brokers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"brokerageId": "770e8400-e29b-41d4-a716-446655440000",
"name": "John Smith"
}
'
{
"id": "550e8400-e29b-41d4-a716-446655440003"
}
Authorizations
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Body
application/json
ID of an existing brokerage this broker belongs to. Use GET /brokerages to find valid IDs, or POST /brokerages to create one first.
Broker name (required)
Broker email address
Default commission percentage (0-100)
Required range:
0 <= x <= 100Structured address information
Show child attributes
Show child attributes
Primary phone number
Work phone number
Producer number/identifier
Response
Broker created successfully
The ID of the created broker
Was this page helpful?
