Update a required additional insured

Módulo Vendors

PATCH/required-additional-insureds/{id}requiredAdditionalInsureds.update

A party the org requires its vendors' certificates to name (1130): org-wide when project_id is null, or for vendors engaged on one project as well. app.verify_onboarding_insureds checks an engagement against them. 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

requiredAdditionalInsureds.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the required additional insured.

Cuerpo de la solicitud: RequiredAdditionalInsuredUpdate

requiredAdditionalInsureds.update: RequiredAdditionalInsuredUpdate
Campo	Tipo	Obligatorio	Descripción
insured_name	string	No	Party that must be named.Restricciones: length 1 to 200
endorsement_kind	"Additional Insured" \| "Primary and Noncontributory" \| "Waiver of Subrogation"	No	Endorsement: Additional Insured, Primary and Noncontributory, or Waiver of Subrogation.

{
  "insured_name": "Example Venue Owner LLC",
  "endorsement_kind": "Additional Insured"
}

Respuesta 200: RequiredAdditionalInsured

requiredAdditionalInsureds.update: RequiredAdditionalInsured
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the required additional insured.
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.
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.
project_id	string (uuid) \| null	Sí	Identifier of the project the requirement adds to; null for every project.
insured_name	string	Sí	Party that must be named.Restricciones: length 1 to 200
endorsement_kind	"Additional Insured" \| "Primary and Noncontributory" \| "Waiver of Subrogation"	Sí	Endorsement: Additional Insured, Primary and Noncontributory, or Waiver of Subrogation.

{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "insured_name": "Example Venue Owner LLC",
  "endorsement_kind": "Additional Insured"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/required-additional-insureds/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 '{"insured_name":"Example Venue Owner LLC","endorsement_kind":"Additional Insured"}'

const { data, etag } = await xos.requiredAdditionalInsureds.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "insured_name": "Example Venue Owner LLC",
    "endorsement_kind": "Additional Insured"
  }, { ifMatch: etag });

response = xos.required_additional_insureds.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"insured_name": "Example Venue Owner LLC", "endorsement_kind": "Additional Insured"}, if_match=etag)

xos required-additional-insureds update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"insured_name":"Example Venue Owner LLC","endorsement_kind":"Additional Insured"}' --if-match auto