POST /admin.conversations.create

Create a public or private channel-based conversation.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

token String Yes

Authentication token. Requires scope: admin.conversations:write

Request body fields

Name Type Required Description
name String Yes

Name of the public or private channel to create.

description String No

Description of the public or private channel to create.

team_id String No

The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.

is_private Boolean Yes

When true, creates a private channel instead of a public channel

org_wide Boolean No

When true, the channel will be available org-wide. Note: if the channel is not org_wide=true, you must specify a team_id for this channel

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.