RelayAPI

Redeem a bearer invitation

Authenticated, rate-limited redemption atomically consumes the bearer token, creates or upgrades membership, resolves a stable member principal, and applies its workspace grants.

POST
/v1/invite/tokens/redeem
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/invite/tokens/redeem" \  -H "Content-Type: application/json" \  -d '{    "token": "string"  }'
{  "member": {    "id": "string",    "role": "owner"  },  "organization": {    "id": "string",    "name": "string",    "slug": "string"  },  "principal": {    "id": "string",    "scope_mode": "all",    "workspace_ids": [      "string"    ]  },  "redeemed_at": "2019-08-24T14:15:22Z"}

Found something wrong? Help us improve this page.