ClarifyAPI
Object Access

Grant object access

Grants another user entity-wide access delegation: the same access you have to every record of the given object type. Requires a paid plan with access delegation enabled. Requires a user-backed API key; workspace-actor API keys are not supported.

POST
/workspaces/{workspace}/objects/{object}/access
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 object type this delegation applies to: meeting or message.

Value in

  • "meeting"
  • "message"

Query Parameters

silent?boolean

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

Header Parameters

clarify-version?string

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 POST "https://example.com/workspaces/string/objects/meeting/access" \  -H "clarify-version: 2026-10" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "object-access",      "attributes": {        "delegate_id": "2b6e4f8a-3d1c-4a9e-8b5f-7c2a9d0e4f63"      }    }  }'
{  "data": {    "type": "object-access",    "id": "a1f4e6d2-8c9b-4f3a-9d5e-1b6c8a2f7d90",    "attributes": {      "_id": "a1f4e6d2-8c9b-4f3a-9d5e-1b6c8a2f7d90",      "owner_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",      "delegate_id": "2b6e4f8a-3d1c-4a9e-8b5f-7c2a9d0e4f63",      "entity": "meeting",      "_created_at": "2026-01-15T09:30:00.000Z",      "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",      "_updated_at": null,      "_updated_by": null    }  }}