ArcalotlArcalotl
Members

Create a member link code

Creates a one-time code that links an identity on the intended platform to this Arcalotl member. The code expires after 10 minutes. Creating a new code for the same member and platform invalidates the previous code; letting a code expire does not change the member or their entitlements. Requires the `members:write` scope.

Serverhttps://api.arcalotl.com
POST
/v1/members/{id}/link-codes
AuthorizationBearer <token>

Community-scoped API key. Send it as Authorization: Bearer arclt_live_.... Keys carry scopes; endpoints that need a specific scope answer 403 missing_scope when the key lacks it.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

intended_platform*string

The first-party platform where the member will redeem the code.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/members/string/link-codes" \  -H "Content-Type: application/json" \  -d '{    "intended_platform": "discord"  }'
{
  "code": "ABC123XY",
  "member_id": "mem_01JMZX1Z7D",
  "intended_platform": "discord",
  "expires_at": "2019-08-24T14:15:22Z"
}
{
  "type": "https://docs.arcalotl.com/api/errors#invalid_request",
  "title": "Bad Request",
  "status": 400,
  "detail": "The 'cursor' parameter is not a valid cursor from a previous response.",
  "code": "invalid_request"
}
{
  "type": "https://docs.arcalotl.com/api/errors#unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid API key is required. Provide it as 'Authorization: Bearer arclt_live_...'.",
  "code": "unauthorized"
}
{
  "type": "https://docs.arcalotl.com/api/errors#missing_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This API key is missing the required scope: subscriptions:read.",
  "code": "missing_scope"
}
{
  "type": "https://docs.arcalotl.com/api/errors#not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource was not found.",
  "code": "not_found"
}
{
  "type": "https://docs.arcalotl.com/api/errors#rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Rate limit exceeded. Retry after the interval in the Retry-After header.",
  "code": "rate_limited"
}