Skip to main content
PATCH
Update a group
Dashboard session only. API keys cannot call this operation.

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Path Parameters

groupId
integer<uint64>
required

Group id. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

Changes to a group; permissions and memberIds are replaced as a whole.

name
string

New name (not for default groups).

Required string length: 1 - 80
description
string | null

Description.

Maximum string length: 500
permissions
string[]

New permissions.

Maximum array length: 100

A permission (role) key such as view-consumer-catalog or create-consumer-redemptions. See Permissions and scopes and GET /partner/v1/permissions.

Pattern: ^[a-z][a-z0-9-]*$
memberIds
integer<uint64>[]

New member list.

Maximum array length: 500

Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Response

OK

Single-object envelope around a Group.

data
object
required

A group of members with its permissions.