Onboarding step 3 — description
Onboarding
Onboarding step 3 — description
Submit the listing description. Companion to step 3 — photos.
PATCH
Onboarding step 3 — description
Overview
Submits the listing’s free-text description. This is the companion to step 3 — photos: both must be present beforecurrentStep advances to 4.
Saving the description sets currentStep = 4. Photos must already be on the listing — submitting the description first returns 409 STATE_CONFLICT.
The description is constrained to 100..150 characters inclusive (deliberate — short enough for one card, long enough to be more than a tweet).
Preconditions:
currentStepis exactly3.- A step-2 listing exists with at least one photo (i.e. step-3-photos has already fired).
Authentication
Bearer <accessToken> required. Scope: user.
Path parameters
None.Query parameters
None.Request body
| Field | Type | Required | Allowed values / Constraints | Example |
|---|---|---|---|---|
description | string | yes | 100..150 characters inclusive | Bright 2-bed flat in Camden, two minutes from the tube, recently refurbished kitchen, south-facing balcony with a view of the canal. |
Example payload
Response — 200 OK
Returns the refreshed onboarding state.currentStep advances to 4.
| Field | Type | Allowed values | Example |
|---|---|---|---|
onboardingStatus | enum | IN_PROGRESS, COMPLETE | IN_PROGRESS |
currentStep | integer | null | advances to 4 | 4 |
tenancyStatus | enum | unchanged | PENDING |
Example response
Error responses
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_FAILED | Description is shorter than 100 or longer than 150 characters. |
| 401 | UNAUTHENTICATED | Missing, malformed, or expired access token. |
| 409 | STATE_CONFLICT | currentStep is not 3, the step-2 listing is missing, or no photos have been submitted yet. |
Example error — 400
Side effects
- Sets
current_homes.descriptionto the submitted text. - Sets
users.currentStep = 4.