Skip to main content
POST
TypeScript

Autorisations

Authorization
string
header
requis

An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

membership:create

En-têtes

Idempotency-Key
string

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

Maximum string length: 255
Exemple:

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

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Corps

application/json
user_id
string
requis

Recipient user ID, prefixed user_. Pass exactly one of user_id or email.

Exemple:

"user_xxxxxxxxxxxxxx"

variant_id
string
requis

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

Exemple:

"plan_xxxxxxxxxxxxxx"

email
string<email>

Recipient email address. Pass exactly one of user_id or email.

Exemple:

"marcus@shinetime.example"

Réponse

invitation accepted for delivery

invitation_sent
boolean
requis
Exemple:

true