Skip to main content
POST
Invite a member
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.

Headers

Idempotency-Key
string

Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

Invitation.

email
string<email>
required

Email of the person to invite (normalised to lower case).

groupIds
integer<uint64>[]

Active groups of your partner to add the member to (at most 20).

Maximum array length: 20

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
directPermissions
string[]

Permissions to grant directly (at most 100); you can grant only permissions you hold.

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-]*$

Response

Created

Single-object envelope around a PartnerMembership.

data
object
required

A user's membership in your partner.