Skip to content
XOS Developers

Delete a record grant

Settings module

DELETE/record-grants/{id}recordGrants.delete

A grant on specific records, with scope and expiry. Soft-deletes the record grant: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.access_grants.manage.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

recordGrants.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the record grant.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/record-grants/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.recordGrants.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.record_grants.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos record-grants delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f