design-partner

Send the workspace's shared Slack channel invite

Send the workspace's invitation to the address in the body. With no channel yet this starts the run that creates one and sends the invitation from inside it, and answers provisioning for the page to poll; with a channel ready the invitation goes out immediately.

A workspace gets one invitation to its channel, so a second call while the first is still live is a 409 rather than a second email. Nothing here happens on a page load: the address is required, so a call without a body is a 422.

A refusal Slack itself made, their Slack being on a free plan for instance, is not an error: it comes back in the body with a sentence to show them.

post/design-partner/slack-channel/invite/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/design-partner/slack-channel/invite/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

emailstring 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.

Response

Successful Response

channel_failure_messagestring nullable required

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

channel_namestring nullable required

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

channel_state'none' | 'provisioning' | 'ready' | 'failed' 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.

channel_urlstring nullable required

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

invite_can_sendboolean 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_emailstring nullable required

The address the invitation went to.

invite_messagestring nullable 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_atstring date-time nullable required

When Slack accepted the invitation.

invite_status'none' | 'sent' | 'refused' required

What became of the workspace's invitation.

Changes

No recorded changes to this operation across all 1 revision of this API.