Skip to main content
PUT
Update group

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group
string
required

The group ID

Body

application/json
name
string
required
Maximum string length: 50
timezone
string
required

Must be a valid timezone

Example:

"Europe/Prague"

type
enum<integer>

1 Group
2 Brand
3 Client
4 Agency
5 Campaign
6 Project

Available options:
1,
2,
3,
4,
5,
6
week_start_day
enum<integer>

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Available options:
0,
1,
2,
3,
4,
5,
6
note
string | null
Maximum string length: 500
country
string | null
max_social_accounts
number | null

Limit the max number of accounts in this group.

Required range: x >= 1
default_everyone_must_approve
boolean

Does not apply for API.

default_assignee_ids
string[] | null

Does not apply for API. List of user IDs. These users will be preselected as assignees when creating a new post in the post composer.

Response

GroupData

id
string
required
organization_id
string
required
author_id
string | null
required

The ID of the user who created the group

name
string
required
timezone
string
required
approval_workflow
enum<integer> | null
required

Approval workflow for this group. If null, the organization's default approval workflow is used

0 None
1 Loose
2 Strict

Available options:
0,
1,
2
week_start_day
enum<integer>
required

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Available options:
0,
1,
2,
3,
4,
5,
6
note
string | null
required

Internal note

country
string | null
required
color
enum<integer>
required

1 Red
2 Green
3 Blue
4 Yellow
5 Orange
6 Pink
7 Purple
8 Sky
9 Gray

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9
type
enum<integer>
required

1 Group
2 Brand
3 Client
4 Agency
5 Campaign
6 Project

Available options:
1,
2,
3,
4,
5,
6
avatar
string | null
required

URL to the profile image of the group

default_assignee_ids
string[]
required

Does not apply for API. Selected users will be pre-selected as assignees in new posts

default_everyone_must_approve
boolean
required
post_task_templates_enabled
boolean
required

When false, post task templates (global or group-scoped) are not applied to posts created in this group

max_social_accounts
integer | null
required

Max number of accounts in this group. Unlimited if null

is_default
boolean
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
socialAccounts
SocialAccountData · object[]
required

List of social accounts in the group.

Data on request, you must add socialAccounts to the include parameter

socialAccountsCount
integer | null
required

Data on request, you must add socialAccountsCount to the include parameter