Skip to main content
DELETE
/
api
/
external
/
companies
/
{companyId}
/
payees
/
{payeeId}
Delete Payee
curl --request DELETE \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId} \
  --header 'Authorization: <api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "deleted": true
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your key in the Authorization header: Authorization: ApiKey YOUR-API-KEY

Path Parameters

​
companyId
string<uuid>
required

Company identifier

​
payeeId
string<uuid>
required

Payee identifier

Response

Payee deleted successfully

​
id
string<uuid>

The ID of the deleted payee

​
deleted
boolean

Confirmation that the payee was deleted