Skip to main content
POST
Invite a member
Dashboard session only. API keys cannot call this operation.

Authorizations

Authorization
string
header
required

ID token of a signed-in dashboard user. Operations that API keys cannot call use it.

Headers

Idempotency-Key
string

Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). 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

Invite a member.

email
string
required

Email address.

groupIds
integer<uint64>[]

Up to 20 groups.

Maximum array length: 20

Unsigned 64-bit integer. May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000
directPermissions
string[]

Up to 100 permissions.

Maximum array length: 100

Permission.

Response

Success.

Single-object envelope around PartnerMembership.

data
object
required

A member of your partner.