Delete an insurance certificate insured
Vendors module
DELETE/insurance-certificate-insureds/{id}insuranceCertificateInsureds.delete
A party a certificate of insurance names, with the endorsement it grants (1130). A name appears once per endorsement on a certificate, ignoring case and spacing (409). Soft-deletes the insurance certificate insured: it moves to Trash and can be restored for its table's retention period.
- Requires the capability vendors.coi.write.
- OAuth scopes: vendors.
- Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the insurance certificate insured. |
Response 204: no body.
Code samples
curl -X DELETE "$XOS_BASE_URL/insurance-certificate-insureds/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data } = await xos.insuranceCertificateInsureds.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.insurance_certificate_insureds.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos insurance-certificate-insureds delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f