Update a record access grant
Changes the access level of an existing grant on a record. Only the record’s owner or a workspace permission admin (records and lists), the record’s owner (messages), a participant (meetings), or the assignee or creator (tasks) can manage grants. Requires a user-backed API key; workspace-actor API keys are not supported.
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
The shareable object the record belongs to: a record entity (deal, company, person, task, a custom object) or list / meeting / message.
The unique ID of the shared record.
The unique ID of the grant.
Query Parameters
When true, suppresses in-app and Slack notifications for this mutation and batches its live updates, so open views can lag by up to 20 seconds.
Header Parameters
The API version for this request. Send 2026-10 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/workspaces/string/objects/string/records/string/access/string" \ -H "clarify-version: 2026-10" \ -H "Content-Type: application/json" \ -d '{ "data": { "type": "object-record-access", "attributes": { "access_level": "edit" } } }'{ "data": { "type": "object-record-access", "id": "2f4a6c8e-0b1d-4a3f-8c5e-7a9b1c3d5e6f", "attributes": { "_id": "2f4a6c8e-0b1d-4a3f-8c5e-7a9b1c3d5e6f", "object_id": "9d2c4e6f-8a1b-4c3d-9e5f-7a9b1c3d5e7f", "grantee_type": "user", "grantee_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "access_level": "edit", "source": "share", "_created_at": "2026-01-15T09:30:00.000Z", "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "_updated_at": null, "_updated_by": null } }}Revoke a record access grant
Permanently removes an access grant from a record. Only the record’s owner or a workspace permission admin (records and lists), the record’s owner (messages), a participant (meetings), or the assignee or creator (tasks) can manage grants. Returns 202 Accepted with an empty body. Requires a user-backed API key; workspace-actor API keys are not supported.
Attach an uploaded file to a record
Links a previously uploaded file (see the upload-URL endpoint) to the record and returns the updated record.