Release units from a project
Aufruf, Parameter, Antwort und Fehler von POST /v1/projects/{externalProjectId}/unassign.
Zuletzt aktualisiert:
Releases units: they stay as plain listings with their data and hold the key of their own address again (409 address_already_exists if another listing holds it). The listing keeps its own state: a reserved or sold unit stays reserved or closed, and a paused one stays paused; no unit.status_updated is sent, because the listing is no unit any more. A listing that is not a unit of this project is refused with errors naming it. Needs write access to projects.
Braucht den Scope propose und mindestens die Stufe write auf projects.
Aufruf
POST https://api.athaus.ai/v1/projects/{externalProjectId}/unassignParameter
Pfad
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
externalProjectId | string | ja | 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. |
Kopf
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
Athaus-Version | string | nein | 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 | nein | 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. |
Rumpf
JSON mit Content-Type: application/json. Ein Feld, das die API nicht kennt, ist ein 400, und errors[].name nennt das Feld. Der Rumpf ist Pflicht.
| Feld | Typ | Beschreibung |
|---|---|---|
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. |
Beispiel
curl -X POST "https://api.athaus.ai/v1/projects/PRJ-1-ext/unassign" \
-H "Authorization: Bearer ath_live_..." \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"externalListingIds":["PRJ-7-WE-1","PRJ-7-WE-2"]}'Antwort
Bei Erfolg kommt 202 mit ProjectUnitsReceipt.
ProjectUnitsReceipt
| Feld | Typ | Beschreibung |
|---|---|---|
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 |
Köpfe der Antwort
| Kopf | Beschreibung |
|---|---|
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. |
Fehler
Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.
| Status | Codes | Bedeutung |
|---|---|---|
400 | api_version_unsupported, invalid_body | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
409 | address_already_exists | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. |
413 | payload_too_large | The request body is larger than 512 KB. |
415 | invalid_input | The request body is not JSON. Send Content-Type: application/json. |
422 | idempotency_key_reused | The idempotency key was already used with a different request body. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.