Create a record access grant

Shares a single record of a shareable object (`list`, `meeting`, or `message`) with a user or the whole workspace at a given access level. Only the record’s owner or a workspace permission admin (lists), the record’s owner (messages), or a participant (meetings) can create grants. Requires a user-backed API key; workspace-actor API keys are not supported.

Authorization

apiKey

Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

object*string

The shareable object the record belongs to: list, meeting, or message.

id*string

The unique ID of the shared record.

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*

Response Body

`application/json`

curl -X POST "https://example.com/workspaces/string/objects/list/records/string/access" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "object-record-access",      "attributes": {        "grantee_type": "user",        "grantee_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",        "access_level": "view"      }    }  }'

{
  "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": "view",
      "_created_at": "2026-01-15T09:30:00.000Z",
      "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",
      "_updated_at": null,
      "_updated_by": null
    }
  }
}