Skip to main content
POST
Invite guests by email

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Path Parameters

id
string
required

Collection id. Never a slug — see the Concepts page.

Body

application/json
emails
string<email>[]
required

Each address is emailed an invite. Capped at 25 per call.

Required array length: 1 - 25 elements

Response

Who was invited.

invited
string[]
required

The addresses invited, lower-cased and deduplicated.