Light mode version of Land Your Home
V1Invites

Post Transaction Invite

POST
/v1/transactions/{transactionId}/invites

Invites someone, by email, to a transaction. The user needs transactionParty.canEdit and can't offer more permissions than they hold. expires is never (default), oneDay, oneWeek, twoWeeks or oneMonth. emailSent is whether PropChain sent the email.

Required variables:

  • baseUrl
  • apiKey (needs invites:write)
  • userToken
  • transactionId (set by chains/Get Chain)

Sets inviteId.

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

Path Parameters

transactionId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/transactions/string/invites"
{  "data": {    "id": "4f6c7d1e-2c1e-4a3a-9d55-1d3a2f0b9a10",    "emailSent": true  }}

Post Invite Decline

The invitee declines a pending invite addressed to their email. The executed request is the sender trying to decline an invite sent to someone else, which is 403 forbidden.

Post Licence 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.