ShareWithChannel
Share an item with the current members of a channel by writing a channel entity-access grant.
Starter documentation. Features and account details may differ from this deployment.
ShareWithChannel
Share an item with the current members of a channel by writing a channel entity-access grant. Call it only when the user asks you to share an existing item; items you create while answering a channel message and link in your reply as a mention chip or attachment are already shared with that channel. entityType is the stored type: calendar_event for a calendar chip, document, project, database, form, call, thread, agent_session, or external_chat. entityId is that item's id. A calendar event can be shared only by someone who holds it on their own calendar, and private or confidential events are refused. Sharing again is safe when a grant already exists.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
channelId | string | Yes | Channel id whose current members should be able to view the item. |
entityId | string | Yes | Id of the item to share. For a calendar chip this is the event id in documentId. |
entityType | "calendar_event" | "document" | "project" | "database" | "form" | "call" | "thread" | "agent_session" | "external_chat" | Yes | Entity types a channel grant can cover. Values are the stored entity types. calendar is accepted for a calendar chip, whose stored type is calendar_event. |