Accept an invite

POST

/api/v1/invites.accept

Uses up the invite token. Without a session it creates the account (password required) and signs in. With a session whose email matches it adds the invite's grants to that account.

Needs no sign-in. Not available to MCP clients or the assistant.

Request Body

application/json

body

token*string

The token from the invite link.

Length1 <= length <= 200

name?string

Lengthlength <= 80

password?string

At least 10 characters.

Length10 <= length <= 1024

Response Body

Success.

application/json

response

status*string|string

viewer*

challenge?

Example Request

curl -X POST 'https://example.com/api/v1/invites.accept' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "string"
}'

Example Request

curl -X POST 'https://example.com/api/v1/invites.accept' \  -H 'Content-Type: application/json' \  -d '{  "token": "string"}'

Example ResponseSchema

{
  "status": "signedIn",
  "viewer": {
    "id": "string",
    "email": "[email protected]",
    "name": "string",
    "role": "owner"
  },
  "challenge": {
    "ticket": "string",
    "methods": [
      "totp"
    ],
    "expiresAt": "2019-08-24T14:15:22Z"
  }
}

{  "status": "signedIn",  "viewer": {    "id": "string",    "email": "[email protected]",    "name": "string",    "role": "owner"  },  "challenge": {    "ticket": "string",    "methods": [      "totp"    ],    "expiresAt": "2019-08-24T14:15:22Z"  }}

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Request Body

Response Body