Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Groups

Update a group with the given id

Updates a group's name.

put/dashboards/{dashboard_id}/groups/{group_id}

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

group_idinteger required

Id of group

Request body

namestring required

Name of the group.

notesstring

Any notes on this group.

Example request

{
  "name": "Employees",
  "notes": "This list will hold all current employees."
}

Response

The group was updated.

idinteger

The group identifier. This will appear in contacts indicating group membership.

group_member_countinteger

Number of members of the group.

is_keywordboolean

If this group is a keyword group. Such groups are autogenerated when a user sets up a keyword. Contacts are automatically added when they enroll.

namestring

Name of the group.

notesstring

Any notes on this group.

last_message_sent_utcstring date-time

Last group message sent from here.

Example response

{
  "id": 121,
  "name": "Employees",
  "notes": "This list will hold all current employees."
}