Skip to main content
PATCH
/
api
/
external
/
companies
/
{companyId}
/
brokerages
/
{brokerageId}
curl --request PATCH \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/brokerages/{brokerageId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Agency Name"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Updated Agency Name",
  "commissionPaymentMethod": "agencyBill",
  "niprBrokerageNumber": "12345678",
  "email": "contact@acmeagency.com",
  "addressStructured": {
    "line1": "123 Main Street",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US"
  },
  "phone": "+1-555-123-4567",
  "defaultCommissionPercentage": 15,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-20T09:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.aiinsurance.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Path Parameters

companyId
string<uuid>
required

Company identifier

brokerageId
string<uuid>
required

Brokerage identifier

Body

application/json
name
string

Update brokerage name

commissionPaymentMethod
enum<string>

Method for handling commission payments

Available options:
agencyBill,
directBill,
doNotHandle
niprBrokerageNumber
string

Update NIPR brokerage number

email
string<email>

Update brokerage email address

addressStructured
object

Structured address information

phone
string

Update phone number

defaultCommissionPercentage
number

Update default commission percentage

Response

Brokerage updated successfully

A brokerage (insurance agency or broker) in the system

id
string<uuid>

Brokerage identifier

name
string

Brokerage name

commissionPaymentMethod
enum<string>

Method for handling commission payments

Available options:
agencyBill,
directBill,
doNotHandle
niprBrokerageNumber
string | null

NIPR brokerage number

email
string<email> | null

Brokerage email address

addressStructured
object

Structured address information

phone
string | null

Phone number

defaultCommissionPercentage
number | null

Default commission percentage for this brokerage

createdAt
string<date-time> | null

When the brokerage was created (ISO 8601)

updatedAt
string<date-time> | null

When the brokerage was last updated (ISO 8601)