POST /im/groups

Create an IM directory group under your account.

Scopes: imgroup:write:admin

Rate Limit Label: Light

Servers

Request headers

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

Default value: "application/json"

Request body fields

Name Type Required Description
search_by_domain Boolean No

Members can search for others in the same email domain.

search_by_account Boolean No

Members can search for others under same account.

name String No

Group name: must be unique to one account.

type String No

IM Group types:
normal - Only members can see automatically see the other members of this group. Other people can search for members within this group.
shared - Everyone under an account can see the group members automatically.
restricted - Nobody can see the group or search for members except the members in the group.

Valid values:

  • "normal"
  • "shared"
  • "restricted"

Default value: "normal"

search_by_ma_account Boolean No

Members can search for others under same master account, including all sub accounts.

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.