Create or update a project
Request, parameters, response and errors of PUT /v1/projects/{externalProjectId}.
Last updated:
Updates the project with this external id, which is your reference or the id Athaus gave it. It merges: a member the body does not name stays. An unknown id is a 404 unless createIfMissing=true, which creates it under the id of the path. The body's metadata.source.offererMarketingKey, if present, must equal the id in the path. Safe to repeat. Needs write access to projects.
Requires the scope propose and at least the level write on projects.
Request
PUT https://api.athaus.ai/v1/projects/{externalProjectId}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. |
Query
| Name | Type | Required | Description |
|---|---|---|---|
createIfMissing | string | no | Create the project when the id is unknown. Without it an unknown id is a 404. Default false. |
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. |
If-None-Match | string | no | *: only if no resource with this reference exists yet (create, never change). 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.
| Field | Type | Description |
|---|---|---|
data | object | |
data.estateType | string | One of NEW_BUILD_PROJECT, NEW_HOME_PROJECT. |
data.estateSubType | string | object | null | any | |
data.distributionType | string | One of BUY, RENT, BUY_RENT. |
data.units | object | |
data.units.numberOfUnits | number | 0 to 999999. |
data.units.priceFrom | number | 0 to . |
data.units.priceTo | number | 0 to . |
data.units.livingSpaceFrom | number | 0 to . |
data.units.livingSpaceTo | number | 0 to . |
data.units.numberOfRoomsFrom | number | 0 to . |
data.units.numberOfRoomsTo | number | 0 to . |
data.units.furnishingLevel | string | One of NOT_PROVIDED, STANDARD, UPSCALE, FULL. |
data.units.provisionType | string | One of PROVISION_FREE, PROVISION_FOR_BUYER, NOT_PROVIDED. |
data.units.provisionPercent | number | 0 to . |
data.units.provisionIsVatIncluded | string | One of YES, NO, NOT_PROVIDED. |
data.units.soldOutPercentage | number | 0 to . |
data.location | object | |
data.location.postalcode | string | |
data.location.city | string | |
data.location.street | string | |
data.location.houseNumber | string | |
data.location.unit | string | |
data.location.staircase | string | |
data.location.floorNumber | integer | -5 to 999. |
data.location.entrance | string | |
data.location.state | string | |
data.location.country | string | One of 249 values from the list in the standard. |
data.location.geometry | object | |
data.location.geometry.type | string | Always Point. |
data.location.geometry.coordinates | number[] | |
data.location.showAddress | boolean | Default true. |
data.location.locationNote | map<string> | |
data.program | object | |
data.program.projectStatus | string | One of CONSTRUCTION_START, PROJECT_ENDED. |
data.deliveryDate | string | |
data.structure | object | |
data.structure.building | object | |
data.structure.building.numberOfFloors | integer | 1 to 999. |
data.texts | object | |
data.texts.headline | map<string> | |
data.texts.description | map<string> | |
data.texts.features | map<string> | |
data.texts.extendedInformation | map<string> | |
data.texts.area | map<string> | |
data.links | object | |
data.links.externalLinks | object[] | |
data.links.externalLinks[].url | string | |
data.links.externalLinks[].urlType | string | One of MAP, MOVIE, PANORAMA, REVOCATION_INSTRUCTION, OFFERER_DETAIL_PAGE. |
data.links.externalLinks[].title | string | |
data.links.virtualTours | object[] | |
data.links.virtualTours[].url | string | |
data.links.virtualTours[].provider | string | |
data.links.virtualTours[].title | string | |
data.contact | object | |
data.contact.salutation | string | One of Mr, Mrs, Miss, Ms, Mx, Sir, Dame, Dr, Cllr, Lady, Lord. |
data.contact.firstName | string | |
data.contact.lastName | string | |
data.contact.name | string | |
data.contact.emailAddress | string | |
data.contact.phoneNumber | string | |
data.contact.mobilePhoneNumber | string | |
data.contact.imageURL | string | |
data.contact.userHomepage | string | |
data.contact.postalCode | string | |
data.contact.city | string | |
data.contact.street | string | |
data.contact.houseNumber | string | |
data.contact.country | string | |
data.contact.preferredContactType | string | One of ANONYMOUS, BY_PHONE, BY_EMAIL, OWN_WEBSITE. |
data.contact.contactNote | map<string> | |
data.contact.displayedInformation | object | |
data.contact.displayedInformation.mainContactPerson | object | |
data.contact.displayedInformation.additionalContactPerson | object | |
metadata | object | |
metadata.source | object | |
metadata.source.offererMarketingKey | string | |
metadata.source.offererEstateId | string | |
metadata.portalWebKey | string | |
status | string | Ours, not OpenImmo: the name of one of the office's project states, for example Sales. Without it a new project starts in the first state of the office. |
Example
curl -X PUT "https://api.athaus.ai/v1/projects/PRJ-1-ext" \
-H "Authorization: Bearer ath_live_..." \
-H "Content-Type: application/json" \
-d '{"data":{"estateType":"NEW_BUILD_PROJECT","estateSubType":null,"distributionType":"BUY","units":{"provisionType":"PROVISION_FREE"},"location":{"postalcode":"04107","city":"Leipzig","street":"Kantstrasse","houseNumber":"37","country":"DEU","geometry":{"type":"Point","coordinates":[12.3731,51.3397]}},"texts":{"headline":{"de":"Waldstadt Suites"},"description":{"de":"Dreißig Wohnungen am Park."}}},"metadata":{"source":{"offererEstateId":"PRJ-7","offererMarketingKey":"PRJ-7"}},"status":"Vertrieb"}'Response
On success the status is 202 with ProjectReceipt.
ProjectReceipt
| Field | Type | Description |
|---|---|---|
requestId | string | |
projectId | string | |
externalProjectId | string | |
warnings | object[] | |
warnings[].type | string | |
warnings[].message | string |
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
Every error arrives as problem details. Branch on code, not on title or detail.
| Status | Codes | Meaning |
|---|---|---|
400 | invalid_query, api_version_unsupported, invalid_input, 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 | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. | |
412 | 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 | The request body is larger than 512 KB. |
415 | invalid_input | The request body is not JSON. Send Content-Type: application/json. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Keep reading
REST API: authentication with an API key
Every call to /v1 carries an API key as a bearer token. Where to get one, which scopes it carries and what does not work.
REST API: errors as problem details
Every error from /v1 is an RFC 9457 problem with a real HTTP status, a code to branch on and a request id for support.