Lexicon Garden

at.happyproto.actor.acceptInvite

Redeem an invite from admin.createInvites: the caller joins the customers space with read access, and the address the invite went to is paired with the caller's account. Redeeming as an account that is already a customer succeeds and spends nothing. Any signed-in account may call this; the token is the authority.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · procedure
Kindprocedure
Authorityactor.happyproto.at
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

idempotencyKey

requiredstring

A UUID, new for each attempt; a retry reuses it.

token

requiredstring
  • maxLength: 128

Output

application/json

isCustomer

requiredboolean

Always true on success.

joined

requiredboolean

Whether this call made the caller a customer. False when they already were, in which case the invite was not spent.

Errors

AuthRequired

This endpoint requires an authenticated caller.

InvalidRequest

token is missing or malformed, or idempotencyKey is not a UUID.

InvalidInvite

No invite has this token, or it is not an invite to the customers space.

InviteUsed

The invite has already been redeemed, or was revoked.

InviteExpired

The invite has expired.

Upstream

The customers space is not configured, or the invite could not be redeemed.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • at.happyproto.admin.createInvites

    procedure

    Invite customers: mint one single-use customers-space invite per address, each expiring after expiresInDays, and record which address each went to, so a redeemed invite pairs the address with the account. Redeemed with actor.acceptInvite. Staff only.

  • rsvp.atmo.space.invite.redeem

    procedure

    Redeem an invite token. The JWT issuer becomes a member of the space with the invite's perms.

  • at.happyproto.admin.listInvites

    query

    Every customer invite, newest first: the address it went to, whether it is pending, expired or redeemed, and by which account. Staff only.