POST /usergroups.create

Create a User Group

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: usergroups:write

Request body fields

Name Type Required Description
channels String No

A comma separated string of encoded channel IDs for which the User Group uses as a default.

name String Yes

A name for the User Group. Must be unique among User Groups.

description String No

A short description of the User Group.

include_count Boolean No

Include the number of users in each User Group.

handle String No

A mention handle. Must be unique among channels, users and User Groups.

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.