Delete Broker

Soft deletes a broker by setting deletedAt and deletedBy timestamps. The broker will no longer be returned in list or get operations.

Note: This operation will fail if the broker is associated with any policies, drafts, or insureds.

Required permission: company.broker:create

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

Delete Broker

cURL

curl --request DELETE \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/brokers/{brokerId} \
  --header 'Authorization: <api-key>'

200

success

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "deleted": true
}

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

Response

200

application/json

Broker deleted successfully

id · string<uuid>

The ID of the deleted broker

deleted · boolean

Confirmation that the broker was deleted