Light mode version of Land Your Home
V1Stages

Patch Stage

PATCH
/v1/stages/{stageId}

Changes a stage. Only the fields sent change; null clears description, progressNote, expectedUpdate or expectedCompletion. assignedToYou: true assigns it to the caller, false unassigns it. Owners are other people's ids, which partners never see, so a stage can only be assigned to the caller (assignedToYou: true) or left unassigned. If the stage is assigned to the caller and has an expectedUpdate after today, an update reminder is scheduled for 9am that day (and rescheduled or cancelled when the stage changes or is deleted), as in the app.

Required variables:

  • baseUrl
  • apiKey
  • userToken
  • newStageId (set by transactions/Post Transaction Stage)

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

stageId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/stages/string"
{  "data": {    "id": "fc5cfa3d-db26-40e2-a76f-d911c06955c4",    "transactionId": "9a5424e0-2413-4890-a5ca-6e90f4604ae9",    "title": "Searches Ordered",    "description": "Local authority and environmental searches ordered",    "progress": "In Progress",    "progressNote": "Searches ordered with the council",    "expectedUpdate": null,    "expectedCompletion": null,    "assignedToYou": true,    "assigned": true,    "dependsOnStageId": null,    "createdAt": "2026-10-02T08:30:34.119354+00:00",    "updatedAt": "2026-10-02T08:30:34.119354+00:00"  }}