Skip to main content
POST
auth.app-invitation.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
email
string<email>
required

Email address invited to your local app.

Maximum string length: 320
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
role
string
required

App role offered; your server authorizes this choice.

Required string length: 1 - 64
returnUrl
string<uri>
required

Invitation page on your verified domain or an exact saved callback URL.

Maximum string length: 2048

Response

The result

status
string
required

Invitation email accepted for delivery; acceptance creates no local account.

Allowed value: "pending"
expiresAt
string
required

When an unclaimed invitation expires, ISO 8601.

ref
string

Stable opaque invitation reference; always returned, use it to avoid duplicate local accounts.