Skip to main content
POST
TypeScript

Yetkilendirmeler

Authorization
string
header
gerekli

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

Başlıklar

Idempotency-Key
string

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

Maximum string length: 255
Örnek:

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

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Gövde

application/json
user_id
string
gerekli

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

Örnek:

"user_xxxxxxxxxxxxxx"

variant_id
string
gerekli

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

Örnek:

"plan_xxxxxxxxxxxxxx"

email
string<email>

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

Örnek:

"marcus@shinetime.example"

Yanıt

invitation accepted for delivery

invitation_sent
boolean
gerekli
Örnek:

true