Update a record grant
Módulo Settings
PATCH/record-grants/{id}recordGrants.update
A grant on specific records, with scope and expiry. 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.access_grants.manage.
- 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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the record grant. |
Cuerpo de la solicitud: RecordGrantUpdate
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| capability_code | string | No | Capability verb.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| valid_to | string (date-time) | null | No | End of the grant. |
| grantee_person_id | string (uuid) | null | No | Identifier of the person who receives access; null when an organization does. |
| grantee_org_id | string (uuid) | null | No | Identifier of the organization whose active members receive access; null when a person does. |
| valid_from | string (date-time) | No | When access starts. |
| reason | string | No | Why the grant was made, for example the partner agreement clause.Restricciones: length 1 to 2000 |
{
"capability_code": "records.read",
"valid_to": "2026-10-08T14:30:00Z",
"grantee_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"grantee_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_from": "2026-10-08T14:30:00Z",
"reason": "Partner agreement, clause 4.2."
}Respuesta 200: RecordGrant
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the record grant. |
| 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. |
| capability_code | string | Sí | Capability verb.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| valid_to | string (date-time) | null | Sí | End of the grant. |
| target_kind | "organization" | "workspace" | "team" | "project" | "record" | Sí | Kind of target. |
| target_id | string (uuid) | Sí | Identifier of the target row. |
| grantee_person_id | string (uuid) | null | Sí | Identifier of the person who receives access; null when an organization does. |
| grantee_org_id | string (uuid) | null | Sí | Identifier of the organization whose active members receive access; null when a person does. |
| valid_from | string (date-time) | Sí | When access starts. |
| granted_by | string (uuid) | null | Sí | Identifier of the person who granted it; never the grantee. |
| reason | string | Sí | Why the grant was made, for example the partner agreement clause.Restricciones: length 1 to 2000 |
{
"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",
"capability_code": "records.read",
"valid_to": "2026-10-08T14:30:00Z",
"target_kind": "organization",
"target_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"grantee_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"grantee_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_from": "2026-10-08T14:30:00Z",
"granted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"reason": "Partner agreement, clause 4.2."
}Ejemplos de código
curl -X PATCH "$XOS_BASE_URL/record-grants/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 '{"capability_code":"records.read","valid_to":"2026-10-08T14:30:00Z","grantee_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","grantee_org_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","valid_from":"2026-10-08T14:30:00Z","reason":"Partner agreement, clause 4.2."}'const { data, etag } = await xos.recordGrants.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"capability_code": "records.read",
"valid_to": "2026-10-08T14:30:00Z",
"grantee_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"grantee_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_from": "2026-10-08T14:30:00Z",
"reason": "Partner agreement, clause 4.2."
}, { ifMatch: etag });response = xos.record_grants.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"capability_code": "records.read", "valid_to": "2026-10-08T14:30:00Z", "grantee_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "grantee_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "valid_from": "2026-10-08T14:30:00Z", "reason": "Partner agreement, clause 4.2."}, if_match=etag)xos record-grants update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"capability_code":"records.read","valid_to":"2026-10-08T14:30:00Z","grantee_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","grantee_org_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","valid_from":"2026-10-08T14:30:00Z","reason":"Partner agreement, clause 4.2."}' --if-match auto