Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-05-1"

Body

application/json
plan_id
string
required

Free plan whose membership the recipient is invited to, prefixed plan_.

user_id
string
required

Recipient user ID, prefixed user_. Mutually exclusive with email.

email
string<email>

Recipient email address. Mutually exclusive with user_id.

Response

invitation accepted for delivery

invitation_sent
boolean
required