Update Exposure

Updates an existing exposure.

All fields are optional - only send fields being changed. Does NOT allow updating entityType or applicationData (rating data).

Required permission: insured:update

PATCH /api/external/companies/{companyId}/exposures/{exposureId}

cURL

updateName

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

200

success

{
  "id": "550e8400-e29b-41d4-a716-446655440200",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "John Smith Jr.",
  "entityType": "individual",
  "phoneNumber": "[phone]",
  "email": "[e-mail]",
  "billingEmail": null,
  "defaultBrokerId": null,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "createdBy": "google-oauth2|123456789",
  "updatedAt": "2025-01-20T14:00:00.000Z",
  "updatedBy": "google-oauth2|987654321"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

companyId · string<uuid> · required

Company identifier

exposureId · string<uuid> · required

Exposure identifier

Body

application/json

Request body for updating an insured

name · string

Update insured name

phoneNumber · string

Update phone number

email · string<email> | null

Update email (send null to clear)

billingEmail · string<email> | null

Update billing email (send null to clear)

defaultBrokerId · string<uuid> | null

ID of an existing broker to set as default (send null to clear). Use GET /brokers to find valid IDs.

data · object

Custom data fields to merge with existing data. Keys must match fields from GET /insureds/configuration for the insured's entityType. Send null for a key to clear it.

Show child attributes

Response

200

application/json

Exposure updated successfully

Full insured details returned from update operations

id · string<uuid>

Insured identifier

companyId · string<uuid>

Company identifier

name · string

Insured name

entityType · string

Entity type (individual, organization, etc.)

phoneNumber · string | null

Insured phone number

email · string<email> | null

Insured email address

billingEmail · string<email> | null

Billing email address

defaultBrokerId · string<uuid> | null

Default broker ID for this insured

createdAt · string<date-time>

When the insured was created

createdBy · string | null

User who created the insured

updatedAt · string<date-time>

When the insured was last updated

updatedBy · string | null

User who last updated the insured