Update Broker

Updates an existing broker. Only send fields you want to change.

Optional update fields:

• name - Update broker name
• email - Update email address (send null to clear)
• defaultCommissionPercentage - Update default commission (0-100)
• addressStructured - Update address
• phone - Update phone number
• workPhone - Update work phone number
• producerNumber - Update producer number
• brokerageId - Update associated brokerage
• createdAt - Update creation timestamp

Required permission: broker:update

PATCH /api/external/companies/{companyId}/brokers/{brokerId}

cURL

updateName

curl --request PATCH \ --url https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId} \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "name": "John A. Smith" } '

200

success

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "companyId": "660e8400-e29b-41d4-a716-446655440000",
  "brokerageId": "770e8400-e29b-41d4-a716-446655440000",
  "name": "John A. Smith",
  "email": "[e-mail]",
  "phone": "[phone]",
  "workPhone": "[phone]",
  "addressStructured": {
    "line1": "123 Main Street",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US"
  },
  "defaultCommissionPercentage": 15,
  "producerNumber": "PRD-12345",
  "userId": null,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "createdBy": "880e8400-e29b-41d4-a716-446655440000",
  "updatedAt": "2025-01-20T09:00:00.000Z",
  "updatedBy": "880e8400-e29b-41d4-a716-446655440000"
}

Authorizations

Authorization · string · header · required

Use format: ApiKey <your-api-key>

Path Parameters

companyId · string<uuid> · required

Company identifier

brokerId · string<uuid> · required

Broker identifier

Body

application/json

name · string

Update broker name

email · string<email> | null

Update broker email (send null to clear)

defaultCommissionPercentage · number

Update default commission percentage (0-100)

Required range: 0 <= x <= 100

addressStructured · object

Structured address information

Show child attributes

phone · string

Update phone number

workPhone · string

Update work phone number

producerNumber · string

Update producer number

brokerageId · string<uuid>

Update associated brokerage

createdAt · string<date-time>

Update createdAt timestamp (ISO 8601 format)

Response

200

application/json

Broker updated successfully

A broker (individual agent) associated with a brokerage

id · string<uuid>

Broker identifier

companyId · string<uuid>

Company identifier

brokerageId · string<uuid>

The brokerage this broker belongs to

name · string

Broker name

email · string<email> | null

Broker email address

phone · string | null

Primary phone number

workPhone · string | null

Work phone number

addressStructured · object

Structured address information

Show child attributes

defaultCommissionPercentage · number | null

Default commission percentage for this broker

producerNumber · string | null

Producer number/identifier

userId · string<uuid> | null

Associated user ID (if broker has portal access)

createdAt · string<date-time> | null

When the broker was created (ISO 8601)

createdBy · string<uuid> | null

User ID who created the broker

updatedAt · string<date-time> | null

When the broker was last updated (ISO 8601)

updatedBy · string<uuid> | null

User ID who last updated the broker