> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Update publication data
> Update publication data of a real estate object.
## OpenAPI
````json PUT /api/v1/realestateobjects/publish/object
{
"openapi": "3.0.4",
"info": {
"title": "RealEstateObjects V1",
"description": "Welcome to BETA version of the new RealEstateObjects API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Admin"
},
{
"name": "Buildings"
},
{
"name": "Complexes"
},
{
"name": "Generic"
},
{
"name": "Metadata"
},
{
"name": "PublishObjects"
},
{
"name": "ScoringPointTotals"
},
{
"name": "Sections"
},
{
"name": "Units"
}
],
"paths": {
"/api/v1/realestateobjects/publish/object": {
"put": {
"tags": [
"Publish"
],
"summary": "Update publication data",
"description": "Update publication data of a real estate object.",
"operationId": "UpdatePublicationData",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationData"
}
}
}
},
"responses": {
"200": {
"description": "The publication data for real estate object was updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationData"
}
}
}
},
"404": {
"description": "The requested real estate object was not found."
}
},
"x-d360-narrative-url": "Update publication data
This endpoint updates the publication status of a real estate object that is currently published.
The object is identified by its internal reference, its external identifier, or both. If both are given, they must refer to the same object, otherwise the request fails.
It is intentionally limited to the publish status and availability, and fully overwrites those fields with the data provided in the request. It does not update the object's other published details.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | Conditional | Internal identifier of the object. Either reference or externalIdentifier must be provided. If both are given, the object must match both values. |
externalIdentifier | string | Conditional | External identifier of the object, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the object must match both values. |
isPublished | boolean | Yes | Indicates whether the object should be published. |
publishedDate | string (date) | No | Date the object was initially published. ISO 8601 format. |
publishedStatus | integer | Yes | Publication status of the object. Valid values are 0 (Available), 1 (Reserved), 2 (Rented), or 3 (UnderOption). |
availableFrom | string (date-time) | No | Date and time from which the object is available. ISO 8601 format. |
Response Fields
Field | Type | Required | Description |
|---|
reference | string | No | Internal identifier of the object. |
externalIdentifier | string | No | External identifier of the object. |
isPublished | boolean | Yes | Indicates whether the object is published. |
publishedDate | string (date) | No | Date the object was initially published. |
publishedStatus | integer | Yes | Publication status of the object. Valid values are 0 (Available), 1 (Reserved), 2 (Rented), or 3 (UnderOption). |
availableFrom | string (date-time) | No | Date and time from which the object is available. |