Light mode version of Land Your Home
V1Transactions

Patch My Party

PATCH
/v1/transactions/{transactionId}/parties/me

Changes the user's own role and side (Neutral, Buyer or Seller) on a transaction. Permissions are untouched. Sends the user's current values back in the executed request.

Required variables:

  • baseUrl
  • apiKey (needs transactions:write)
  • userToken
  • transactionId, myRole, myRepresenting (set by Get Transaction Parties)

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 PATCH "https://example.com/v1/transactions/string/parties/me"
{  "data": {    "role": "Buyer",    "representing": "Buyer"  }}