Update an insurance certificate

Módulo Vendors

PATCH/insurance-certificates/{id}insuranceCertificates.update

A certificate of insurance naming the required additional insureds. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requiere la capacidad vendors.coi.write.
Alcances de OAuth: vendors.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

insuranceCertificates.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the insurance certificate.

Cuerpo de la solicitud: InsuranceCertificateUpdate

insuranceCertificates.update: InsuranceCertificateUpdate
Campo	Tipo	Obligatorio	Descripción
coverage_type	string	No	Coverage type.Restricciones: length 1 to 300
coverage_limit_minor	integer (int64) \| null	No	Each occurrence limit. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	No	ISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
valid_to	string (date)	No	Expiry.
vendor_id	string (uuid)	No	Identifier of the insured vendor.
insurer	string	No	Insurance carrier.Restricciones: length 1 to 300
policy_identifier	string	No	Policy number.Restricciones: length 1 to 100
valid_from	string (date)	No	First day of coverage.
document_uri	string (uri) \| null	No	Where the certificate document is stored.

{
  "coverage_type": "General Liability",
  "coverage_limit_minor": 100000000,
  "currency_code": "USD",
  "valid_to": "2026-10-08",
  "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "insurer": "Example Mutual",
  "policy_identifier": "GL-2027-0042",
  "valid_from": "2026-10-08",
  "document_uri": "https://northwindlive.example/files/site-plan.pdf"
}

Respuesta 200: InsuranceCertificate

insuranceCertificates.update: InsuranceCertificate
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the insurance certificate.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
coverage_type	string	Sí	Coverage type.Restricciones: length 1 to 300
coverage_limit_minor	integer (int64) \| null	Sí	Each occurrence limit. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	Sí	ISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
valid_to	string (date)	Sí	Expiry.
vendor_id	string (uuid)	Sí	Identifier of the insured vendor.
insurer	string	Sí	Insurance carrier.Restricciones: length 1 to 300
policy_identifier	string	Sí	Policy number.Restricciones: length 1 to 100
valid_from	string (date)	Sí	First day of coverage.
document_uri	string (uri) \| null	Sí	Where the certificate document is stored.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "coverage_type": "General Liability",
  "coverage_limit_minor": 100000000,
  "currency_code": "USD",
  "valid_to": "2026-10-08",
  "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "insurer": "Example Mutual",
  "policy_identifier": "GL-2027-0042",
  "valid_from": "2026-10-08",
  "document_uri": "https://northwindlive.example/files/site-plan.pdf"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/insurance-certificates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"coverage_type":"General Liability","coverage_limit_minor":100000000,"currency_code":"USD","valid_to":"2026-10-08","vendor_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","insurer":"Example Mutual","policy_identifier":"GL-2027-0042","valid_from":"2026-10-08","document_uri":"https://northwindlive.example/files/site-plan.pdf"}'

const { data, etag } = await xos.insuranceCertificates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "coverage_type": "General Liability",
    "coverage_limit_minor": 100000000,
    "currency_code": "USD",
    "valid_to": "2026-10-08",
    "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "insurer": "Example Mutual",
    "policy_identifier": "GL-2027-0042",
    "valid_from": "2026-10-08",
    "document_uri": "https://northwindlive.example/files/site-plan.pdf"
  }, { ifMatch: etag });

response = xos.insurance_certificates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"coverage_type": "General Liability", "coverage_limit_minor": 100000000, "currency_code": "USD", "valid_to": "2026-10-08", "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "insurer": "Example Mutual", "policy_identifier": "GL-2027-0042", "valid_from": "2026-10-08", "document_uri": "https://northwindlive.example/files/site-plan.pdf"}, if_match=etag)

xos insurance-certificates update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"coverage_type":"General Liability","coverage_limit_minor":100000000,"currency_code":"USD","valid_to":"2026-10-08","vendor_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","insurer":"Example Mutual","policy_identifier":"GL-2027-0042","valid_from":"2026-10-08","document_uri":"https://northwindlive.example/files/site-plan.pdf"}' --if-match auto