# Update a listing

Adresse: https://docs.athaus.ai/en/api/v1/referenz/patch-listing

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

Type: Reference
Last updated: 2026-11-14

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`](/en/api/v1/anmeldung#scopes).

## Request [#request]

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

### Parameters [#parameters]

**Path**

| Name                | Type     | Required | Description                                                                                                                                                                                                                                                               |
| ------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `externalListingId` | `string` | yes      | Your 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**

| Name             | Type     | Required | Description                                                                                                                                                  |
| ---------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Athaus-Version` | `string` | no       | Optional 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-Match`       | `string` | no       | Only if the current ETag of the resource is listed (or `*`: only if the resource exists). Otherwise 412 and nothing is written.                              |

### Request body [#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.

| Field         | Type              | Description |
| ------------- | ----------------- | ----------- |
| `data`        | `object \| any`   |             |
| `metadata`    | `object \| any`   |             |
| `userDefined` | `object[] \| any` |             |
| `media`       | `object[] \| any` |             |
| `contact`     | `object \| any`   |             |

### Example [#example]

```bash
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 [#response]

On success the status is `202` with `ListingReceipt`.

### ListingReceipt [#listingreceipt]

| Field                | Type       | Description |
| -------------------- | ---------- | ----------- |
| `requestId`          | `string`   |             |
| `listingId`          | `string`   |             |
| `externalListingId`  | `string`   |             |
| `warnings`           | `object[]` |             |
| `warnings[].type`    | `string`   |             |
| `warnings[].message` | `string`   |             |

### Response headers [#response-headers]

| Header             | Description                                                                                                     |
| ------------------ | --------------------------------------------------------------------------------------------------------------- |
| `Request-Id`       | Identifies this request. Quote it in a support request.                                                         |
| `Athaus-Version`   | The API version of this response: v1.                                                                           |
| `Athaus-Release`   | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
| `RateLimit-Policy` | The quota policy of the bucket that applies.                                                                    |
| `RateLimit`        | Remaining quota and seconds until the bucket is full again.                                                     |

## Errors [#errors]

Every error arrives as [problem details](/en/api/v1/fehler). Branch on `code`, not on `title` or `detail`.

| Status | Codes                                                                                                                                                                                                                            | Meaning                                                                                                                    |
| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `400`  | [`api_version_unsupported`](/en/api/errors#api_version_unsupported), [`invalid_input`](/en/api/errors#invalid_input), [`invalid_body`](/en/api/errors#invalid_body), [`profile_unsupported`](/en/api/errors#profile_unsupported) | Invalid request.                                                                                                           |
| `401`  | [`unauthorized`](/en/api/errors#unauthorized)                                                                                                                                                                                    | Missing or invalid API key.                                                                                                |
| `403`  | [`insufficient_permissions`](/en/api/errors#insufficient_permissions), [`plan_required`](/en/api/errors#plan_required)                                                                                                           | The key lacks a right, or the plan does not include API access.                                                            |
| `404`  | [`not_found`](/en/api/errors#not_found)                                                                                                                                                                                          | Nothing under this ID.                                                                                                     |
| `409`  | [`address_already_exists`](/en/api/errors#address_already_exists)                                                                                                                                                                | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.                |
| `412`  | [`precondition_failed`](/en/api/errors#precondition_failed)                                                                                                                                                                      | The condition of `If-Match` (or `If-None-Match`) does not hold for the current state of the resource. Nothing was written. |
| `413`  | [`payload_too_large`](/en/api/errors#payload_too_large)                                                                                                                                                                          | The request body is larger than 512 KB.                                                                                    |
| `415`  | [`invalid_input`](/en/api/errors#invalid_input)                                                                                                                                                                                  | The request body is not JSON. Send `Content-Type: application/json`.                                                       |
| `429`  | [`rate_limited`](/en/api/errors#rate_limited)                                                                                                                                                                                    | Rate limit exceeded.                                                                                                       |
| `500`  | [`internal_error`](/en/api/errors#internal_error)                                                                                                                                                                                | Server error.                                                                                                              |
