Skip to main content
PATCH
Pause or resume a Slack connection

Authorizations

X-API-Key
string
header
required

Path Parameters

connection_id
string<shortuuid>
required

ID of the Slack connection. Returned as the id field on every Slack connection response.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Fields of a Slack connection a caller may change.

is_active
boolean
required

false pauses deliveries to the channel without dropping its access; true resumes them.

Response

OK

A Slack channel the organization delivers to. The bot token is never part of the response.

id
string<shortuuid>
required

ID of the Slack connection. Returned as the id field on every Slack connection response.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
purpose
enum<string>
required

What kind of events this channel receives.

Available options:
notifications,
feedback,
signals,
founder,
proof_of_brand
team_id
string
required

The Slack workspace ID.

team_name
string
required

The Slack workspace name, for display.

channel_id
string
required

The Slack channel ID.

channel_name
string
required

The Slack channel name, for display, without a leading #.

is_active
boolean
required

Whether deliveries are sent to this channel. false when it was paused or disconnected, or when Slack revoked access.

token_valid
boolean
required

false once access has been revoked, by a disconnect or by Slack. Nothing is delivered in that state whatever is_active says; reconnect the channel through the install URL.

signal_delivery_mode
enum<string>
required

For signals channels: send each Product Signal immediately, or hold for one daily digest.

Available options:
per_signal,
digest_daily