Contents x
    Update an estate agent
    • 21 Aug 2024
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Update an estate agent

    • Updated on 21 Aug 2024
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Put
    /api/v1/relations/estateAgents

    Update an existing estate agent. This will fully overwrite the estate agent with the data from the request.

    Description

    Update an existing estate agent. This will fully overwrite the estate agent with the data from the request. Both the 'reference' and the 'externalIdentifier' can be used to identify the estate agent 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 (estate agent). If this is not the case, the request will return with an error code and the estate agent will not be overwritten.

    Estate agent includes a wide range of real estate brokerage services, including but not limited to real estate agents, brokers, and rental agents.

    Use Case

    The Bloxs user has added an estate agent with multiple incorrect properties. Therefore the user wants to change several properties simultaneously rather than making several requests and changing one property at a time.

    FieldDescription
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system .
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    phoneNumberPhone number of the relation.
    mobileNumberMobile phone number of the relation.
    cocNumberChamber of Commerce number.
    cocDescriptionAdditional information about the Chamber of Commerce number. Termed as KVK description in the Bloxs system. Extra information can be entered here regarding the Chamber of Commerce number.
    vatNumberVAT (BTW) number of the relation.
    correspondenceMethod

    The default method of correspondence. This field is an integer with 2 options:

    1 = Email

    2 = Post

    If the correspondenceMethod is set to Email, then the primaryEmailAddresses field is mandatory.

    If the CorrespondenceMethod is set to Post, then the Address field is mandatory.

    remarks
    		General comments. Please note: avoid including sensitive information here, such as passwords or sensitive personal data.
    languageISOCode
    		ISO language code. Use the 2-letter code from the ISO 639-1 Code list.
    address
    		The address of the relation.
    streetThe street of the relation.
    houseNumber
    		The house number of the relation.
    postalCode
    		The postal code of the relation.
    cityThe place of residence of the relation.
    countryISOCode
    		ISO country code. Use the 2-letter code from the ISO 639-1 Code list.
    invoiceAddress
    		The billing address of the relation. In case this field is empty, the data from 'address' will be used. This is mainly relevant for certain templates.
    postalAddressThe postal address of the relation. In case this field is empty, the data from 'address' will be used. This is mainly relevant for certain templates.
    primaryEmailAddressesPrimary email address used by the relation. If other email addresses are left empty, this email address will be used for correspondence.
    invoicesEmailAddressesThe email address used to send invoices.
    paymentRemindersEmailAddressesThe email address used to send reminders regarding payments.
    indexationsEmailAddressesThe email address to which the annual rent increase (indexation) is sent.
    serviceTicketsEmailAddressesThe email address to which all maintenance notifications are sent. This may differ from the general email address. For instance, in the case of a shared office space where all communication is centralized through one central desk instead of being handled separately by individual tenants.
    purchaseOrdersEmailAddressesAll communication specifically related to procurement is conducted through this email address. This is primarily applicable to large parties where procurement processes are managed through separate email accounts.
    portalsEmailAddressesWithin Bloxs, a portal account for customers or tenants can be opened. Through this field, you can provide multiple email addresses that need to be granted access.
    otherEmailAddressesOther email addresses.
    nameName of the relation.
    websiteWebsite of the relation.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    externalIdentifier
    string | null
    Max length100
    Min length0
    phoneNumber
    string | null
    mobileNumber
    string | null
    cocNumber
    string | null
    Max length256
    Min length0
    cocDescription
    string | null
    vatNumber
    string | null
    Max length256
    Min length0
    correspondenceMethod
    integer (int32) Required

    1 = Email

    2 = Post

    Valid values[ \1\, \2\ ]
    remarks
    string | null
    languageISOCode
    string | null
    Max length2
    Min length0
    address
    object (Address)
    street
    string Required
    Max length200
    Min length0
    houseNumber
    string | null
    Max length40
    Min length0
    postalCode
    string | null
    Max length20
    Min length0
    city
    string Required
    Max length200
    Min length0
    countryISOCode
    string Required
    Max length2
    Min length0
    invoiceAddress
    object (Address)
    street
    string Required
    Max length200
    Min length0
    houseNumber
    string | null
    Max length40
    Min length0
    postalCode
    string | null
    Max length20
    Min length0
    city
    string Required
    Max length200
    Min length0
    countryISOCode
    string Required
    Max length2
    Min length0
    postalAddress
    object (Address)
    street
    string Required
    Max length200
    Min length0
    houseNumber
    string | null
    Max length40
    Min length0
    postalCode
    string | null
    Max length20
    Min length0
    city
    string Required
    Max length200
    Min length0
    countryISOCode
    string Required
    Max length2
    Min length0
    primaryEmailAddresses
    Array of string | null
    string
    invoicesEmailAddresses
    Array of string | null
    string
    paymentRemindersEmailAddresses
    Array of string | null
    string
    indexationsEmailAddresses
    Array of string | null
    string
    serviceTicketsEmailAddresses
    Array of string | null
    string
    purchaseOrdersEmailAddresses
    Array of string | null
    string
    portalsEmailAddresses
    Array of string | null
    string
    otherEmailAddresses
    Array of string | null
    string
    name
    string Required
    Max length256
    Min length0
    website
    string | null
    reference
    string | null
    Max length100
    Min length0
    Responses
    200

    The estate agent was updated

    Expand All
    object
    externalIdentifier
    string | null
    Max length100
    Min length0
    phoneNumber
    string | null
    mobileNumber
    string | null
    cocNumber
    string | null
    Max length256
    Min length0
    cocDescription
    string | null
    vatNumber
    string | null
    Max length256
    Min length0
    correspondenceMethod
    integer (int32)

    1 = Email

    2 = Post

    Valid values[ \1\, \2\ ]
    remarks
    string | null
    languageISOCode
    string | null
    Max length2
    Min length0
    address
    object (Address)
    street
    string
    Max length200
    Min length0
    houseNumber
    string | null
    Max length40
    Min length0
    postalCode
    string | null
    Max length20
    Min length0
    city
    string
    Max length200
    Min length0
    countryISOCode
    string
    Max length2
    Min length0
    invoiceAddress
    object (Address)
    street
    string
    Max length200
    Min length0
    houseNumber
    string | null
    Max length40
    Min length0
    postalCode
    string | null
    Max length20
    Min length0
    city
    string
    Max length200
    Min length0
    countryISOCode
    string
    Max length2
    Min length0
    postalAddress
    object (Address)
    street
    string
    Max length200
    Min length0
    houseNumber
    string | null
    Max length40
    Min length0
    postalCode
    string | null
    Max length20
    Min length0
    city
    string
    Max length200
    Min length0
    countryISOCode
    string
    Max length2
    Min length0
    primaryEmailAddresses
    Array of string | null
    string
    invoicesEmailAddresses
    Array of string | null
    string
    paymentRemindersEmailAddresses
    Array of string | null
    string
    indexationsEmailAddresses
    Array of string | null
    string
    serviceTicketsEmailAddresses
    Array of string | null
    string
    purchaseOrdersEmailAddresses
    Array of string | null
    string
    portalsEmailAddresses
    Array of string | null
    string
    otherEmailAddresses
    Array of string | null
    string
    name
    string
    Max length256
    Min length0
    website
    string | null
    reference
    string | null
    Max length100
    Min length0
    400

    The estate agent data has validation issues

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string additionalProperties
    string
    What's Next