Introduction
The API for creating requests has been simplified in November 2024.
You’ll find the current API documentation here: RealEquity public API v2 reference.
Below you’ll find a brief verbal description of the individual requests and some examples.
When are message requests used
Message requests are used for sending form data from the website to agents business application on the RealEquity platform.
A request is posted when the visitor presses the ‘Submit’ botton on a filled in form.
To avoid spam and DDoS attacks we strongly recommend that all forms are protected by CAPTCHA
Notifications
In general the messages/requests trigges a notification in RealEquity and will be attached to the case or appointment that is referenced in the request/message. The notifyee can be the store or - for case specific requests - employees with a role on the referenced case.
Supported message/request types
General message
General message to a store from the website with or without a case reference.
Request example
For message to the store with no case reference, apply the resourceGroupId parameter:
POST {{api}}/api/messages/v2/general-request?resourceGroupId={{resourceGroupId}}
For message to the store with a specific case reference, apply the caseId parameter:
POST {{api}}/api/messages/v2/general-request?caseId={{caseId}}
{
"subject": "Curabitur nunc justo",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua",
"requestingActor": {
"firstName": "Hans Christian",
"lastName": "Andersen",
"address": {
"streetName": "Hans Jensens Stræde",
"streetNumber": "45",
"zipCode": "5000",
"city": "Odense"
},
"emailAddress": "hca@fairytales.dk"
}
}
Sales valuation request
Message from the website generated by a vistor who wants a sales valuation of his or her property.
Request example
POST {{api}}/api/messages/v2/salesvaluation?resourceGroupId={{resourceGroupId}}
{
"subject": "Salgsvurdering",
"message": "Jeg vil gerne have en salgsvurdering af mit slot på Trige Skovvej 1, 8520 Lystrup",
"requestingActor": {
"firstName": "Archibald",
"lastName": "Haddock",
"address": {
"streetName": "Trige Skovvej",
"streetNumber": "1",
"zipCode": "8520",
"city": "Lystrup"
},
"emailAddress": "kaptajnen@mollenborgslot.com"
}
}
Counselling request
Message from the websited generated when a vistor wants to be contacted about councelling.
Request example
POST
{
"subject": "Køberrådgivning",
"message": "Jeg vil gerne have set papirerne igennem på et huskøb jeg er ved at foretage gennem en anden mægler.",
"requestingActor": {
"firstName": "Archibald",
"lastName": "Haddock",
"address": {
"streetName": "Trige Skovvej",
"streetNumber": "1",
"zipCode": "8520",
"city": "Lystrup"
},
"emailAddress": "kaptajnen@mollenborgslot.com"
}
}
Wish request
Message from the website containing wish criterias, that a visitor wants to be registered with by the store.
Request example (using multiPolygonCoordinates)
POST {{api}}/api/messages/v2/createwish?resourceGroupId={{resourceGroupId}}
{
"subject": "Opskrivning i køberkartotek",
"message": "Ønske oprettet via hjemmeside",
"RequestingActor": {
"firstName": "Louis",
"lastName": "Armstrong",
"address": {
"streetName": "Basunvænget",
"streetNumber": "9",
"zipCode": "4200",
"city": "Slagelse"
},
"emailAddress": "louis@satchmo.dk"
},
"wish": {
"internalNote": "Oprettet via hjemmesiden",
"description": "(offentlig note)",
"typeNamespace": "dk.realequity.wish.boligønske",
"estateTypes": [
"dk.realequity.estate.villalejlighed",
"dk.realequity.estate.villa"
],
"priceRange": {
"upperValue": 8000000
},
"energyLabelRange": {
"upperValue": "d"
},
"multiPolygonCoordinates": [
[
[11.56676335508831, 55.39755856167154],
[11.544518691147635, 55.38466926899178],
[11.51831731458882, 55.33343166788055],
[11.551877113483153, 55.31697575331068],
[11.636784624874776, 55.381149412372864],
[11.56676335508831, 55.39755856167154]
]
]
}
}
Request example (using zipCodes and zipCodeRanges)
POST {{api}}/api/messages/v2/createwish?resourceGroupId={{resourceGroupId}}
{
"subject": "Opskrivning i køberkartotek",
"message": "Ønske oprettet via hjemmeside",
"RequestingActor": {
"firstName": "Louis",
"lastName": "Armstrong",
"address": {
"streetName": "Basunvænget",
"streetNumber": "9",
"zipCode": "4200",
"city": "Slagelse"
},
"emailAddress": "louis@satchmo.dk"
},
"wish": {
"internalNote": "Oprettet via hjemmesiden",
"description": "(offentlig note)",
"typeNamespace": "dk.realequity.wish.boligønske",
"estateTypes": [
"dk.realequity.estate.villalejlighed",
"dk.realequity.estate.villa"
],
"priceRange": {
"upperValue": 8000000
},
"zipCodeSourceIds": ["2000","2900"],
"zipCodeRanges": [
{
"lowerValue": 1000,
"upperValue": 1500
},
{
"lowerValue": 3000,
"upperValue": 3400
}
],
"energyLabelRange": {
"upperValue": "c"
}
}
}
Sales material fetched message[1]
Information from website that particulars has been downloaded on a specific case. Information is automaticly stored on the case.
Request example
POST {{api}}/api/messages/v2/salesmaterialfetched?caseId={{caseId}}
{
"subject": "Salgsmateriale rekvireret",
"message": "Nedenstående kunde har downloaded salgsmateriale på sagen",
"requestingActor": {
"firstName": "Hans Christian",
"lastName": "von Andersen",
"address": {
"streetName": "Munkemøllestræde",
"streetNumber": "3",
"zipCode": "5000",
"city": "Odense"
},
"emailAddress": "hca@fairytales.dk"
}
}
Openhouse signup request
Message from the website generated by a vistor who wants to attend a specific open house appointment having booking required.
Request example
POST {{api}}/api/messages/v2/openhousesignup?appointmentId={{appointmentId}}
{
"requestingActor": {
"firstName": "Archibald",
"lastName": "Haddock",
"address": {
"streetName": "Trige Skovvej",
"streetNumber": "1",
"zipCode": "8520",
"city": "Lystrup"
},
"emailAddress": "kaptajnen@mollenborgslot.com"
}
}
Houseshowing request
Message from the website generated by a vistor who wants a houseshowing on a specific case.
Request example
POST {{api}}/api/messages/v2/houseshowing?caseId={{caseId}}
{
"subject": "Anmodning om fremvisning",
"message": "Nedenstående kunde har via hjemmesiden ønsket at få en fremvisning af den refererede ejendom.",
"requestingActor": {
"firstName": "Hans Christian",
"lastName": "Andersen",
"address": {
"streetName": "Munkemøllestræde",
"streetNumber": "3",
"zipCode": "5000",
"city": "Odense"
},
"emailAddress": "hca@fairytales.dk"
}
}
Bid proposal message
Message to be used by the website when potential buyers wants to put in a bid on a specific case.
Request example
POST {{api}}/api/messages/v2/bidproposal?caseId={{caseId}}
{
"subject": "Bud afgivet",
"message": "Eventuelt forslag til overtagelsesdato kan vises her, hvis formular på websitet lægger op til forslag herom",
"requestingActor": {
"firstName": "Hans Christian",
"lastName": "Andersen",
"address": {
"streetName": "Munkemøllestræde",
"streetNumber": "3",
"zipCode": "5000",
"city": "Odense"
},
"emailAddress": "hca@fairytales.dk"
},
"price": 3200000
}
Send files for case
Request that can be used to send files regarding a specific case to the store.
Request example
Since the Content-Type is “multipart/form-data” the example is generated as a cURL code snippet generated with Postman.
Further more the requestingActor is identified only by an actorId, just to illustrate that this can be used as an alternative to name and address info, when the actorId is known to the website/customer universe.
POST {{api}}/api/messages/v2/send-file?caseId={{caseId}}
curl --location 'https://sync.prod.realequity.dk/api/messages/v2/send-file?caseId=a939e4bd-08e7-4119-9f3b-6930d6a307a9' \
--header 'Authorization: Bearer <removed to free space>' \
--form 'body="{\"subject\":\"Fil(er) modtaget fra kundeunivers\",\"message\":\"Her er det ønskede dokument\",\"requestingActor\":{\"actorId\":\"9b8889f5-0db5-4e33-85d9-a1f9f9687a37\"}}"' \
--form 'file1=@"/C:/Test/Testdokument 1.pdf"'
Until February 7th, 2025 it’s been stated that the “Sales material fetched message” does not trigger a notification. This is no longer the case. ↩︎
