Update Group

Update a group. The account, API access, analysis email, and account manager fields can only be modified by administrators.

group_idintegerRequired

This endpoint expects an object.

namestringOptional

accountstringOptional

The account of the group. Must be a valid domain, URL, or email. The account will be normalized to a canonical form.

thumbnail_urlstringOptional

The thumbnail URL of the group

analysis_emailstringOptional

The email address for analysis to be sent to

data_api_accessbooleanOptional

Whether the group has access to the data API

account_manager_idintegerOptional

Successful Response

namestring

The name of the group

accountstring

The account of the group. Must be a valid domain, URL, or email. The account will be normalized to a canonical form.

idinteger

thumbnail_urlstring or null

The thumbnail URL of the group

analysis_emailstring or null

The email address for analysis to be sent to

data_api_accessboolean or null

Whether the group has access to the data API

created_atdatetime or null

updated_atdatetime or null

is_archivedboolean or null

account_managerobject or null

user_countinteger or null

deal_countinteger or null

userslist of objects or null

1	{
2	"name": "name",
3	"account": "example.com",
4	"id": 1,
5	"thumbnail_url": "thumbnail_url",
6	"analysis_email": "analysis_email",
7	"data_api_access": true,
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"is_archived": true,
11	"account_manager": {
12	"name": "name",
13	"email": "email",
14	"thumbnail_url": "thumbnail_url"
15	},
16	"user_count": 1,
17	"deal_count": 1,
18	"users": [
19	{
20	"name": "name",
21	"email": "email",
22	"id": 1,
23	"roles": [
24	{
25	"id": 1,
26	"name": "name"
27	}
28	],
29	"thumbnail_url": "thumbnail_url",
30	"created_at": "2024-01-15T09:30:00Z",
31	"updated_at": "2024-01-15T09:30:00Z",
32	"is_archived": true
33	}
34	]
35	}