Contents x
    Update publication data
    • 06 Jun 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Update publication data

    • Updated on 06 Jun 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Put
    /api/v1/realestateobjects/publish/object

    Update publication data of a real estate object.

    Description

    Update the properties of a currently published real estate object. Using this operation will fully overwrite the published data with the data from the request. Both the 'reference' and the 'externalIdentifier' can be used to identify the object which needs to be overwritten. Preferably only the reference is used. If this is not available, the externalIdentifier can be used. If both properties are used it is important that both are correct and match with the same entity (object). If this is not the case, the request will return with an error code and the published data will not be overwritten.

    Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.

    Use Case

    After retrieving the specific published details regarding a certain real estate object with the PublicationData/GET endpoint,  the user notices that one of the properties is outdated. For example, the objectStatus was 'Available'. However,  since the object is currently under option the objectStatus should be changed. By using the PUT operation the user can change the status to  'UnderOption'.

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe reference of the real estate object from which the published data needs to be retrieved. This reference is generated by Bloxs.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    isPublishedThis is a boolean indicating whether the data is published or not.
    publishedDateThe date on which the real estate object was initially published. Later updates of the data do not influence this date.
    publishedStatusEnumeration regarding the status of the real estate object. For example 'available' or 'under option'.
    availableFromThe date from which the property is available.


    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    object
    reference
    string | null
    externalIdentifier
    string | null
    isPublished
    boolean
    publishedDate
    string (date) | null
    publishedStatus
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    availableFrom
    string (date-time) | null
    Responses
    200

    The publication data for real estate object was updated

    object
    reference
    string | null
    externalIdentifier
    string | null
    isPublished
    boolean
    publishedDate
    string (date) | null
    publishedStatus
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    availableFrom
    string (date-time) | null
    404

    The requested real estate object was not found.

    What's Next