Update an access grid entry

Módulo Credentials

PATCH/access-grid/{id}accessGridEntries.update

A zone by credential category access rule with a time window. 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 credentials.access_grid.write.
Alcances de OAuth: credentials.
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

accessGridEntries.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the access grid entry.

Cuerpo de la solicitud: AccessGridEntryUpdate

accessGridEntries.update: AccessGridEntryUpdate
Campo	Tipo	Obligatorio	Descripción
access_level_enum_id	string	No	Access level: a row of the canon Access Level enumeration.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
window_starts_at	string (date-time)	No	When access opens.
window_ends_at	string (date-time)	No	When access closes.

{
  "access_level_enum_id": "ENM-036",
  "window_starts_at": "2026-10-08T14:30:00Z",
  "window_ends_at": "2026-10-08T14:30:00Z"
}

Respuesta 200: AccessGridEntry

accessGridEntries.update: AccessGridEntry
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the access grid entry.
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.
zone_id	string (uuid)	Sí	Identifier of the zone.
credential_category_id	string (uuid)	Sí	Identifier of the credential category.
access_level_enum_id	string	Sí	Access level: a row of the canon Access Level enumeration.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
window_starts_at	string (date-time)	Sí	When access opens.
window_ends_at	string (date-time)	Sí	When access closes.
project_id	string (uuid)	Sí	Identifier of the project of the category, copied from it.

{
  "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",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "credential_category_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "access_level_enum_id": "ENM-036",
  "window_starts_at": "2026-10-08T14:30:00Z",
  "window_ends_at": "2026-10-08T14:30:00Z",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/access-grid/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 '{"access_level_enum_id":"ENM-036","window_starts_at":"2026-10-08T14:30:00Z","window_ends_at":"2026-10-08T14:30:00Z"}'

const { data, etag } = await xos.accessGridEntries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "access_level_enum_id": "ENM-036",
    "window_starts_at": "2026-10-08T14:30:00Z",
    "window_ends_at": "2026-10-08T14:30:00Z"
  }, { ifMatch: etag });

response = xos.access_grid_entries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"access_level_enum_id": "ENM-036", "window_starts_at": "2026-10-08T14:30:00Z", "window_ends_at": "2026-10-08T14:30:00Z"}, if_match=etag)

xos access-grid-entries update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"access_level_enum_id":"ENM-036","window_starts_at":"2026-10-08T14:30:00Z","window_ends_at":"2026-10-08T14:30:00Z"}' --if-match auto