RelayAPI

Create an invite token

Create a single-use invite token with a 7-day expiry. The full token is returned only once — store it securely.

POST
/v1/invite/tokens
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

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

curl -X POST "https://api.relayapi.dev/v1/invite/tokens" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "token": "string",
  "invite_url": "http://example.com",
  "scope": "all",
  "workspace_ids": [
    "string"
  ],
  "role": "owner",
  "expires_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

Found something wrong? Help us improve this page.

Submit an Issue
Requires a GitHub account.View repo