Skip to main content
POST
Preview a product invite with the token in the body.

Body

application/json
token
string
required

The opaque pinv_… invite token from the accept link.

Response

Invite preview.

status
enum<string>
required
Available options:
live,
accepted,
expired,
revoked
products
string[]
required
needs_account
boolean
required

True only when the invite is live and its invited email has no account yet.

account_state_unknown
boolean

Present (true) only when the account lookup for a live email-bound invite failed, so whether the invited email has an account is unknown. Clients should offer both sign-up and sign-in.

open
boolean

Present (true) only for an open (QR) invite. Lets the website word a used-code refusal as a QR problem and confirm before a signed-in visitor binds the code to themselves.