Update a time off policy

Módulo Crew

PATCH/time-off-policies/{id}timeOffPolicies.update

A time off policy. 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 org.payroll.write.
Alcances de OAuth: org.
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

timeOffPolicies.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the time off policy.

Cuerpo de la solicitud: TimeOffPolicyUpdate

timeOffPolicies.update: TimeOffPolicyUpdate
Campo	Tipo	Obligatorio	Descripción
name	string	No	Policy name.Restricciones: length 1 to 300
accrual_hours_per_period	number \| null	No	Hours accrued per pay period.

{
  "name": "Paid Time Off",
  "accrual_hours_per_period": 3.08
}

Respuesta 200: TimeOffPolicy

timeOffPolicies.update: TimeOffPolicy
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the time off policy.
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.
name	string	Sí	Policy name.Restricciones: length 1 to 300
accrual_hours_per_period	number \| null	Sí	Hours accrued per pay period.

{
  "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",
  "name": "Paid Time Off",
  "accrual_hours_per_period": 3.08
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/time-off-policies/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 '{"name":"Paid Time Off","accrual_hours_per_period":3.08}'

const { data, etag } = await xos.timeOffPolicies.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Paid Time Off",
    "accrual_hours_per_period": 3.08
  }, { ifMatch: etag });

response = xos.time_off_policies.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Paid Time Off", "accrual_hours_per_period": 3.08}, if_match=etag)

xos time-off-policies update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Paid Time Off","accrual_hours_per_period":3.08}' --if-match auto