latestOpenAPI 3.1.02026-08-223321,1001.6 MB

2134ebffd1ef

slack-channel-enrollments

Update Engagement Settings

patch/slack/enrollments/settings

Request body

read_only_mode_enabledboolean nullable

Platform admins only. Omit to leave unchanged.

default_channel_mode'MANUAL' | 'AUTO' | 'CUSTOM' | 'READ_ONLY'

How Traversal is wired into a chat channel.

Stored as slack_channel_enrollments.mode. A channel with no enrollment row is implicitly MANUAL; storing an explicit MANUAL row lets the channel carry per-channel state (like custom_instruction) without enabling auto-triggers. Removing a channel from Channel Management entirely is a separate act (archiving the enrollment), not a mode.

READ_ONLY is the one mode that suppresses outbound behavior rather than selecting a flavor of it: Traversal keeps ingesting and storing every message, and answers every interactive surface with a fixed notice instead of doing work. It is only offered while its organization's gate is on -- see engagement_policy. Existing READ_ONLY channels keep the mode when that gate is turned back off, so nothing starts talking again behind a customer's back.

Response

Successful Response

read_only_mode_enabledboolean required

Whether READ_ONLY is offered as a channel mode for this organization. Granted by a Traversal platform admin.

default_channel_mode'MANUAL' | 'AUTO' | 'CUSTOM' | 'READ_ONLY' required

How Traversal is wired into a chat channel.

Stored as slack_channel_enrollments.mode. A channel with no enrollment row is implicitly MANUAL; storing an explicit MANUAL row lets the channel carry per-channel state (like custom_instruction) without enabling auto-triggers. Removing a channel from Channel Management entirely is a separate act (archiving the enrollment), not a mode.

READ_ONLY is the one mode that suppresses outbound behavior rather than selecting a flavor of it: Traversal keeps ingesting and storing every message, and answers every interactive surface with a fixed notice instead of doing work. It is only offered while its organization's gate is on -- see engagement_policy. Existing READ_ONLY channels keep the mode when that gate is turned back off, so nothing starts talking again behind a customer's back.

effective_default_channel_mode'MANUAL' | 'AUTO' | 'CUSTOM' | 'READ_ONLY' required

How Traversal is wired into a chat channel.

Stored as slack_channel_enrollments.mode. A channel with no enrollment row is implicitly MANUAL; storing an explicit MANUAL row lets the channel carry per-channel state (like custom_instruction) without enabling auto-triggers. Removing a channel from Channel Management entirely is a separate act (archiving the enrollment), not a mode.

READ_ONLY is the one mode that suppresses outbound behavior rather than selecting a flavor of it: Traversal keeps ingesting and storing every message, and answers every interactive surface with a fixed notice instead of doing work. It is only offered while its organization's gate is on -- see engagement_policy. Existing READ_ONLY channels keep the mode when that gate is turned back off, so nothing starts talking again behind a customer's back.

selectable_modesEngagementMode[] required

Modes assignable to a channel that has no enrollment row yet. A channel already set to READ_ONLY may additionally keep that mode.

can_manage_read_only_availabilityboolean required

Whether the calling user may change read_only_mode_enabled (platform admins only).