/usergroups.users.update

Update the list of users for a User Group

{ "ok": true, "usergroup": { "auto_type": null, "created_by": "U060R4BJ4", "date_create": 1447096577, "date_delete": 0, "date_update": 1447102109, "deleted_by": null, "description": "Marketing gurus, PR experts and product advocates.", "handle": "marketing-team", "id": "S0616NG6M", "is_external": false, "is_usergroup": true, "name": "Marketing Team", "prefs": { "channels": [], "groups": [] }, "team_id": "T060R4BHN", "updated_by": "U060R4BJ4", "user_count": 1, "users": [ "U060R4BJ4", "U060RNRCZ" ] } }

Request

Header Params

token

string

required

Authentication token. Requires scope: usergroups:write

Body Params application/x-www-form-urlencoded

include_count

string

optional

Include the number of users in the User Group.

usergroup

string

required

The encoded ID of the User Group to update.

users

string

required

A comma separated string of encoded user IDs that represent the entire list of users for the User Group.

Responses

🟢200Typical success response

application/json

Body

Schema for successful response from usergroups.users.update method

enum<boolean>

required

Allowed value:

true

usergroup

object (Subteam/Usergroup Object)

required

auto_provision

boolean

required

auto_type

array [anyOf]

required

channel_count

integer

optional

created_by

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

date_create

integer

required

date_delete

integer

required

date_update

integer

required

deleted_by

array [anyOf]

required

description

string

required

enterprise_subteam_id

string

required

handle

string

required

string

required

Match pattern:

^S[A-Z0-9]{2,}$

is_external

boolean

required

is_subteam

boolean

required

is_usergroup

boolean

required

name

string

required

prefs

object

required

team_id

string

required

Match pattern:

^[T][A-Z0-9]{2,}$

updated_by

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

user_count

integer

optional

users

array[string]

optional

🔴500Typical error response