For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Changes the fields you send and returns the full updated document.
Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.
Authentication
AuthorizationBearer
JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.
Path parameters
idstringRequired
The id of the channel resolver, as returned when it was created or listed.
Request
This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
slack_channel_namestringOptional>=1 character
Display name of the Slack channel, without the leading #.
domains_enabledlist of enumsOptional
Domains the assistant responds to in this channel. If empty, it responds to all posts; otherwise only to posts classified into these domains.
skills_disabledlist of enumsOptional
Skills disabled in this channel. Any of ACCESS_SW, ACCESS_DL, ACCESS_ACCOUNT, ENTERPRISE_SEARCH, or FORM.
Allowed values:
subskills_disabledlist of enumsOptional
Account Access sub-skills disabled in this channel. Any of ACCOUNT_UNLOCK, MFA_RESET, or FORGOT_PASSWORD. Disabling ACCESS_ACCOUNT already disables all of them.
Allowed values:
feedback_enabled_skillslist of enumsOptional
Skills that show feedback (post-back) buttons in the channel. Any of ACCESS_SW, ACCESS_DL, ACCESS_ACCOUNT, or FORM.
Allowed values:
ticket_filing_disabledbooleanOptional
If true, no ticket is filed when a user does not get a correct response in the channel. Useful when channel questions do not belong in your ticketing system.
responding_to_agents_enabledbooleanOptional
If true, the assistant also responds to IT agents in the channel. By default, agents are ignored.
handoff_when_no_response_enabledbooleanOptional
If true, when the assistant has no answer it offers the user handoff options in a DM, such as filing a ticket or talking to an agent. The issue is not marked resolved if handoff is used.
emoji_for_no_resolutionstringOptional
Emoji the assistant reacts with when it cannot resolve a post. Defaults to exclamation. Must differ from emoji_for_resolution and emoji_for_ticket_filed.
emoji_for_resolutionstringOptional
Emoji the assistant reacts with when it provides a resolution. Defaults to white_check_mark. Must differ from emoji_for_no_resolution and emoji_for_ticket_filed.
emoji_for_ticket_filedstringOptional
Emoji the assistant reacts with when a ticket is filed. Defaults to ticket. Must differ from emoji_for_no_resolution and emoji_for_resolution.
emoji_when_no_response_enabledbooleanOptional
If true, the assistant reacts with emoji_for_no_response when it has no response to a post.
emoji_for_no_responsestringOptional
Emoji the assistant reacts with when it has no response to a post. Defaults to exclamation.
emoji_for_manual_creationstringOptional
Emoji that, when applied to a user's post, creates a synced ticket in your ticketing system.
emoji_for_automatic_ticketstringOptional
Emoji the assistant applies to non-agent posts when it automatically creates a ticket. Defaults to ticket.
emoji_for_assign_ticketstringOptional
Emoji an IT agent applies to a post to assign its ticket to themselves.
ticket_syncing_enabledbooleanOptional
If true, Slack thread messages and user-facing ticket comments are synced in both directions. Requires webhooks to be configured in your ticketing system.
ticket_creation_criteriaenumOptional
When synced tickets are created: MANUAL_ONLY when an agent applies the manual creation emoji, or FULLY_SYNCED for every non-agent post.
Allowed values:
assign_ticket_to_bot_upon_reachoutbooleanOptional
If true, tickets created from a channel reachout are assigned to the assistant's service account, and unassigned if the user says the reachout was not helpful.
workflowslist of objectsOptional
Slack workflows that post in this channel, so the assistant can extract the requester and issue from their posts. The list is replaced as a whole on update.
default_domainenumOptional
Default domain used for ticket filing.
updated_timedatetimeOptional
When the configuration was last updated.
updated_bystringOptional
Who last updated the configuration.
Response
The updated channel resolver, at its new version
idstringOptionalRead-only
Unique identifier of this configuration, assigned by the server.
slack_channel_namestringOptional>=1 character
Display name of the Slack channel, without the leading #.
ID of the Slack channel this configuration applies to. Cannot be changed after creation.
domains_enabledlist of enumsOptional
Domains the assistant responds to in this channel. If empty, it responds to all posts; otherwise only to posts classified into these domains.
skills_disabledlist of enumsOptional
Skills disabled in this channel. Any of ACCESS_SW, ACCESS_DL, ACCESS_ACCOUNT, ENTERPRISE_SEARCH, or FORM.
Allowed values:
subskills_disabledlist of enumsOptional
Account Access sub-skills disabled in this channel. Any of ACCOUNT_UNLOCK, MFA_RESET, or FORGOT_PASSWORD. Disabling ACCESS_ACCOUNT already disables all of them.
Allowed values:
feedback_enabled_skillslist of enumsOptional
Skills that show feedback (post-back) buttons in the channel. Any of ACCESS_SW, ACCESS_DL, ACCESS_ACCOUNT, or FORM.
Allowed values:
ticket_filing_disabledbooleanOptional
If true, no ticket is filed when a user does not get a correct response in the channel. Useful when channel questions do not belong in your ticketing system.
responding_to_agents_enabledbooleanOptional
If true, the assistant also responds to IT agents in the channel. By default, agents are ignored.
handoff_when_no_response_enabledbooleanOptional
If true, when the assistant has no answer it offers the user handoff options in a DM, such as filing a ticket or talking to an agent. The issue is not marked resolved if handoff is used.
emoji_for_no_resolutionstringOptional
Emoji the assistant reacts with when it cannot resolve a post. Defaults to exclamation. Must differ from emoji_for_resolution and emoji_for_ticket_filed.
emoji_for_resolutionstringOptional
Emoji the assistant reacts with when it provides a resolution. Defaults to white_check_mark. Must differ from emoji_for_no_resolution and emoji_for_ticket_filed.
emoji_for_ticket_filedstringOptional
Emoji the assistant reacts with when a ticket is filed. Defaults to ticket. Must differ from emoji_for_no_resolution and emoji_for_resolution.
emoji_when_no_response_enabledbooleanOptional
If true, the assistant reacts with emoji_for_no_response when it has no response to a post.
emoji_for_no_responsestringOptional
Emoji the assistant reacts with when it has no response to a post. Defaults to exclamation.
emoji_for_manual_creationstringOptional
Emoji that, when applied to a user's post, creates a synced ticket in your ticketing system.
emoji_for_automatic_ticketstringOptional
Emoji the assistant applies to non-agent posts when it automatically creates a ticket. Defaults to ticket.
emoji_for_assign_ticketstringOptional
Emoji an IT agent applies to a post to assign its ticket to themselves.
ticket_syncing_enabledbooleanOptional
If true, Slack thread messages and user-facing ticket comments are synced in both directions. Requires webhooks to be configured in your ticketing system.
ticket_creation_criteriaenumOptional
When synced tickets are created: MANUAL_ONLY when an agent applies the manual creation emoji, or FULLY_SYNCED for every non-agent post.
Allowed values:
assign_ticket_to_bot_upon_reachoutbooleanOptional
If true, tickets created from a channel reachout are assigned to the assistant's service account, and unassigned if the user says the reachout was not helpful.
workflowslist of objectsOptional
Slack workflows that post in this channel, so the assistant can extract the requester and issue from their posts. The list is replaced as a whole on update.
default_domainenumOptional
Default domain used for ticket filing.
updated_timedatetimeOptional
When the configuration was last updated.
updated_bystringOptional
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.