Skip to main content
POST
Invite a member

Authorizations

Authorization
string
header
required

Management API authentication. Pass an op-mak-… management token as a Bearer token. Runtime op-… API keys are rejected with 403 — they belong on the data-plane endpoints. Mint a management key from the platform UI under Settings → API keys.

Body

application/json
email
string
required

The address to invite.

idempotency_key
string

Makes a retry safe: a repeat with the same key returns the first call's invitation without emailing again or moving the expiry. 1 to 128 letters, digits, dots, underscores, colons or hyphens. Omit it when you mean to resend.

role
string

The role the invitee joins with: a built-in role or one of the organization's custom roles. Enterprise only; on other plans omit it and the plan's default member role applies.

Response

A live invitation for the address was resent (same token, expiry pushed out), or an idempotency_key replay returned the invitation unchanged.

data
object
meta
object

Empty for a single resource. Endpoint-specific context appears here rather than as a sibling of data.