Skip to main content
POST
Add a member or invite

Authorizations

Authorization
string
header
required

API key created in Admin, API. Send it as Authorization: Bearer <key>. Each key has its own permissions and optional IP allow list.

Headers

Idempotency-Key
string

Any unique string up to 255 characters. Retrying with the same key and body replays the first response (header Idempotent-Replayed: true) instead of running the action twice. The same key with a different body returns 409 idempotency_conflict.

Maximum string length: 255

Path Parameters

service
integer
required

Service id.

Body

application/json
email
string<email>
required
invited_by_user_id
integer
required

User recorded as the inviter.

permission_level
enum<string>
required

friends and admin are presets, custom uses permissions.

Available options:
friends,
admin,
custom
permissions
string[]

Permission keys for custom.

Maximum string length: 255

Response

Created.

data
object
required
meta
object
required
message
string

Human readable confirmation.