v2

latestOpenAPI 3.1.02026-08-075421692.0 MB

Invites

Create invite token

Generate a secure invite link to grant team members access to your profiles. Invites expire after 7 days and are single-use.

Returns 403 when a requested profile is not found or not owned, or when called with a restricted (zrk_) API key: invite management is admin-plane.

post/v1/invite/tokens

Request body

scope'all' | 'profiles' required

'all' grants access to all profiles, 'profiles' restricts to specific profiles

profileIdsstring[]

Required if scope is 'profiles'. Array of profile IDs to grant access to.

role'admin' | 'member' | 'billing_admin' | 'viewer'

Org role granted to the invitee. Defaults to 'member'. 'admin' can manage the team (invite/remove members, change roles and access) and billing, but not ownership transfer or account deletion. 'billing_admin' (displayed as Billing Manager) manages billing only. 'viewer' creates a read-only member who can view everything in their profile scope but cannot perform any content mutation (publish, edit, delete, connect accounts).

readOnlyboolean

Deprecated. Use role 'viewer' instead. When true, the invite is created with role 'viewer'. Cannot be combined with role 'billing_admin' or 'admin'.

Response

Invite token created

tokenstring

scopestring

invitedProfileIdsstring[]

expiresAtstring date-time

inviteUrlstring uri