AthausDocs

Update a listing

Request, parameters, response and errors of PATCH /v1/listings/{externalListingId}.

Last updated:

A JSON Merge Patch (RFC 7396) of the OpenImmo 2.0 listing: a member that is missing stays, null clears it. media: [] or null removes the files that came through the API, contact: null removes the contact person. Cannot be cleared: data.distributionType, data.estateType. A running listing blocks changing the address parts or the distribution type (409 listing_active). Needs write access to listings.

Requires the scope propose.

Request

PATCH https://api.athaus.ai/v1/listings/{externalListingId}

Parameters

Path

NameTypeRequiredDescription
externalListingIdstringyesYour reference of the listing: the value of metadata.source.offererMarketingKey. A listing without one has its own listingId here, and the listingId always works in the path. 1 to 128 letters, digits, dots, underscores or hyphens, not starting or ending with a dot.

Header

NameTypeRequiredDescription
Athaus-VersionstringnoOptional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported.
If-MatchstringnoOnly if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written.

Request body

JSON with Content-Type: application/json. A field the API does not know is a 400, and errors[].name names the field. The body is required.

FieldTypeDescription
dataobject | any
metadataobject | any
userDefinedobject[] | any
mediaobject[] | any
contactobject | any

Example

curl -X PATCH "https://api.athaus.ai/v1/listings/WE-12" \
  -H "Authorization: Bearer ath_live_..." \
  -H "Content-Type: application/json" \
  -d '{"data":{"prices":{"buy":{"price":{"amount":340000}}}}}'

Response

On success the status is 202 with ListingReceipt.

ListingReceipt

FieldTypeDescription
requestIdstring
listingIdstring
externalListingIdstring
warningsobject[]
warnings[].typestring
warnings[].messagestring

Response headers

HeaderDescription
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Errors

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400api_version_unsupported, invalid_input, invalid_body, profile_unsupportedInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
409address_already_existsThe request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
412precondition_failedThe condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written.
413payload_too_largeThe request body is larger than 512 KB.
415invalid_inputThe request body is not JSON. Send Content-Type: application/json.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page