Update listing status.
Transition a listing's status between the 5 canonical values (Coming Soon, Active, Pending, Sold, Archived). Requires the listing to be activated (dashboard's activation flow) and billed before API-driven transitions are permitted; otherwise returns 409 listing_not_activated with a remediation URL.
| Method | Path |
|---|---|
PATCH | /api/v1/listings/{listing_number}/status |
Primary host: https://valara.cloud (legacy alias: https://dash.jacoballenmedia.com).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
listing_number | path | yes | string |
Request body
(no request body)
Response
null
Responses
| Status | Description |
|---|---|
200 | Successful Response |
422 | Validation Error (see error codes) |
Examples
curl
curl -X PATCH "https://valara.cloud/api/v1/listings/{listing_number}/status" \
-H "Authorization: Bearer $VALARA_API_KEY" \
-H "Content-Type: application/json" \
-H "X-Idempotency-Key: $(uuidgen)"
Python
import os
import uuid
import httpx
res = httpx.request(
"PATCH",
"https://valara.cloud/api/v1/listings/{listing_number}/status",
headers={
"Authorization": f"Bearer {os.environ['VALARA_API_KEY']}",
"Content-Type": "application/json",
"X-Idempotency-Key": str(uuid.uuid4()),
},
)
res.raise_for_status()
print(res.json())