# Move listings into a project

Adresse: https://docs.athaus.ai/en/api/v1/referenz/assign-project-listings

> Request, parameters, response and errors of POST /v1/projects/{externalProjectId}/assign.

Type: Reference
Last updated: 2026-11-14

Makes existing listings units of the project, up to 500 in one call, all or nothing. Each keeps its own data; its `data.location.unit` is the unit number and must be set and unique in the project (409 `unit_already_exists`, each item named by `externalListingIds[n]`). A listing that is a unit of another project is refused (400): release it there first. A listing whose unit status does not fit the project (a released `sold` unit into a rental project) is 409 `unit_status_invalid`. A listing that is a unit of this project already stays as it is, so a repeat changes nothing. A project holds at most 1000 units: a call that would pass that is 409 `project_unit_limit_exceeded` and changes nothing. Needs write access to `projects`.

Requires the scope [`propose`](/en/api/v1/anmeldung#scopes) and at least the level `write` on `projects`.

## Request [#request]

```http
POST https://api.athaus.ai/v1/projects/{externalProjectId}/assign
```

### Parameters [#parameters]

**Path**

| Name                | Type     | Required | Description                                                                                                                                                                                                                                                               |
| ------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `externalProjectId` | `string` | yes      | Your reference of the project: the value of metadata.source.offererMarketingKey. A project without one has its own projectId here, and the projectId 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`.                                                                                                                                                                                                                                                                         |
| `Idempotency-Key` | `string` | no       | Makes a retry safe: the same key with the same body returns the first answer and writes nothing twice. A random value of at least 128 bits, for example a UUID, 1 to 255 characters. The key is kept for 24 hours and scoped to the API key and this operation. The same key with a different body is a 422; while the first request still runs it is a 409. Only successful answers are kept: after an error the key is free again. |

### 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                                                                                                                                                 |
| -------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `externalListingIds` | `string[]` | The listings to move into the project or out of it. Each keeps its own data when it is assigned; a listing without `data.location.unit` cannot be assigned. |

### Example [#example]

```bash
curl -X POST "https://api.athaus.ai/v1/projects/PRJ-1-ext/assign" \
  -H "Authorization: Bearer ath_live_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"externalListingIds":["PRJ-7-WE-1","PRJ-7-WE-2"]}'
```

## Response [#response]

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

### ProjectUnitsReceipt [#projectunitsreceipt]

| Field                          | Type       | Description                                                          |
| ------------------------------ | ---------- | -------------------------------------------------------------------- |
| `requestId`                    | `string`   |                                                                      |
| `projectId`                    | `string`   |                                                                      |
| `externalProjectId`            | `string`   |                                                                      |
| `listings`                     | `object[]` | The listings the call created or moved, in the order of the request. |
| `listings[].listingId`         | `string`   |                                                                      |
| `listings[].externalListingId` | `string`   |                                                                      |
| `listings[].unit`              | `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.                                                     |
| `Idempotent-Replayed` | `true` when this is the stored answer to an earlier request with the same Idempotency-Key.                      |

## 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_body`](/en/api/errors#invalid_body)                       | 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`  | [`unit_already_exists`](/en/api/errors#unit_already_exists), [`project_unit_limit_exceeded`](/en/api/errors#project_unit_limit_exceeded) | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. |
| `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`.                                        |
| `422`  | [`idempotency_key_reused`](/en/api/errors#idempotency_key_reused)                                                                        | The idempotency key was already used with a different request body.                                         |
| `429`  | [`rate_limited`](/en/api/errors#rate_limited)                                                                                            | Rate limit exceeded.                                                                                        |
| `500`  | [`internal_error`](/en/api/errors#internal_error)                                                                                        | Server error.                                                                                               |
