Create Group

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authorization

This endpoint requires Authorization.

Request Body

KeyTypeDescriptionRequired
namestringName of the group. Must be unique within the organization.Yes
user_idsarrayList of user UUIDs to add to the group on creation. Users not in this organization are silently ignored.No
{
  "name": "London Team",
  "user_ids": ["9e34b87d-79ca-4dc3-ac42-8ce9ebe8be82"]
}

Response

Returns the created group including any initial members:

KeySubkeyTypeDescription
idstringUnique identifier of the group (UUID).
namestringName of the group.
created_atdatetimeTimestamp when the group was created.
usersarrayUsers added to the group at creation.
idstringUser UUID.
namestringUser display name.
emailstringUser email address.

Errors

StatusMessageDescription
422Parameter name is requiredThe name field is missing.
422Name has already been takenA group with this name already exists.
Body Params
string
required
user_ids
array of strings
user_ids
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json