at.happyproto.actor.acceptInvite

happyproto.at

Documentation

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.

main procedure

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.

Input

Encodingapplication/json
idempotencyKey string Required

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

token string Required

No description available.

maxLength: 128 bytes

Output

Encodingapplication/json
isCustomer boolean Required

Always true on success.

joined boolean Required

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.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "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.",
  "errors": [
    {
      "description": "This endpoint requires an authenticated caller.",
      "name": "AuthRequired"
    },
    {
      "description": "token is missing or malformed, or idempotencyKey is not a UUID.",
      "name": "InvalidRequest"
    },
    {
      "description": "No invite has this token, or it is not an invite to the customers space.",
      "name": "InvalidInvite"
    },
    {
      "description": "The invite has already been redeemed, or was revoked.",
      "name": "InviteUsed"
    },
    {
      "description": "The invite has expired.",
      "name": "InviteExpired"
    },
    {
      "description": "The customers space is not configured, or the invite could not be redeemed.",
      "name": "Upstream"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "idempotencyKey": {
          "description": "A UUID, new for each attempt; a retry reuses it.",
          "type": "string"
        },
        "token": {
          "maxLength": 128,
          "type": "string"
        }
      },
      "required": [
        "token",
        "idempotencyKey"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "isCustomer": {
          "description": "Always true on success.",
          "type": "boolean"
        },
        "joined": {
          "description": "Whether this call made the caller a customer. False when they already were, in which case the invite was not spent.",
          "type": "boolean"
        }
      },
      "required": [
        "isCustomer",
        "joined"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@