Skip to main content
POST
Send the workspace's shared Slack channel invite

Authorizations

X-API-Key
string
header
required

Body

application/json

The address a workspace wants its shared-channel invitation sent to.

email
string<email>
required

Where Slack sends the invitation. Typed by the caller rather than taken from their account, because the person who should be in the channel is not always the person setting it up.

Maximum string length: 320

Response

Successful Response

The workspace's shared Slack channel and its one invitation.

Both belong to the organization, so every member of a partner workspace reads the same block: the same channel, the same invitation, whoever sent it. A Slack Connect guest can invite their own colleagues, so the second person through the door is Slack's job rather than ours.

channel_failure_message
string | null
required

What to tell the reader when provisioning failed. Null otherwise.

channel_name
string | null
required

The channel's name, without the leading hash. Null until it is ready.

channel_state
enum<string>
required

Where the workspace's channel is. 'none' means nobody has sent an invite yet, which is what puts the form on the page. 'provisioning' is the run that creates it, which the page polls. 'failed' carries a sentence.

Available options:
none,
provisioning,
ready,
failed
channel_url
string | null
required

A link that opens the channel in the reader's Slack. Null until it is ready.

invite_can_send
boolean
required

Whether to offer the form. False while a run is in flight, while the invitation that went out is still live at Slack, and after a refusal about our own Slack workspace's settings that no retry fixes. Decided here so the page holds no copy of the lifetime and no opinion about which refusals are worth another press.

invite_email
string | null
required

The address the invitation went to.

invite_message
string | null
required

What to tell the reader when Slack refused, already written for a person rather than a log. Null when nothing was refused.

invite_sent_at
string<date-time> | null
required

When Slack accepted the invitation.

invite_status
enum<string>
required

What became of the workspace's invitation.

Available options:
none,
sent,
refused