Light mode version of Land Your Home
V1Licences

Post Licence Redeem

POST
/v1/licences/redeem

Claims the seeded unclaimed licence into the user's oldest team. A licence can only be redeemed once, so a repeat run against the same database returns 409 (run bun run reset in packages/landyourhome-db to repeat); this request accepts either.

Required variables:

  • baseUrl
  • apiKey (needs licences:write)
  • userToken

Authorization

bearerAuth userTokenAuth
AuthorizationBearer <token>

Partner API key (lyh_...): identifies the calling partner, its scopes and rate limit.

In: header

X-User-Token<token>

The user's OAuth 2.1 access token, issued by Land Your Home's OAuth server to this partner's OAuth client. Requests run as this user.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/licences/redeem"
{  "data": {    "id": "11c0de00-0000-4000-8000-0000000000aa"  }}