Raw schema
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"link",
"prepare"
],
"default": "link",
"description": "link: only the form link and the consent text. prepare: check the details, get a summary, the consent text and a confirmation_token for submit_consultation; nothing is sent"
},
"language": {
"type": "string",
"enum": [
"pt",
"en",
"ru",
"ua",
"de",
"fr",
"nl",
"uk"
],
"default": "en",
"description": "The person's language: the consent text, the emails and the page links come in it. Another value is refused, except in mode=link, which falls back to English. uk is accepted as ua."
},
"name": {
"type": "string",
"maxLength": 120,
"description": "The person's name",
"examples": [
"Maria Silva"
]
},
"phone": {
"type": "string",
"description": "Phone in international format. Preferred over email",
"examples": [
"+351 912 345 678"
]
},
"channel": {
"type": "string",
"enum": [
"whatsapp",
"telegram",
"call"
],
"description": "How the person wants to be contacted on that phone"
},
"email": {
"type": "string",
"format": "email",
"description": "Only if the person gives no phone",
"examples": [
"maria@example.com"
]
},
"places": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Where the person wants to buy: municipalities in Portugal (Lisboa or Lisbon) or districts, most important first. At least one place, unless project is given (the project's municipality comes first then)",
"examples": [
[
"Porto",
"Matosinhos"
]
]
},
"city": {
"type": "string",
"description": "Older name for places: one place. Merged with places, city first",
"examples": [
"Porto"
]
},
"project": {
"type": "string",
"description": "Optional. Slug of the development the request is about: the slug field of search_newbuilds"
},
"budget_min": {
"type": "integer",
"description": "Optional. Lower end of the budget in whole euros",
"examples": [
250000
]
},
"budget_max": {
"type": "integer",
"description": "Optional. Upper end of the budget in whole euros; if lower than budget_min, the two are swapped",
"examples": [
400000
]
},
"budget": {
"type": "integer",
"deprecated": true,
"description": "Deprecated: use budget_max. Read as budget_max when budget_min and budget_max are both empty"
},
"budget_band": {
"type": "string",
"deprecated": true,
"description": "Deprecated: use budget_min and budget_max. An old band (0-250k, 250-400k, 400-600k, 600k+), read as its range when both are empty",
"examples": [
"250-400k"
]
},
"property_type": {
"type": "string",
"deprecated": true,
"description": "Deprecated and ignored: every request is for a new-build apartment",
"examples": [
"apartment"
]
},
"deal_type": {
"type": "string",
"deprecated": true,
"description": "Deprecated and ignored: every request is to buy",
"examples": [
"buy"
]
},
"typology": {
"type": "array",
"items": {
"type": "string",
"enum": [
"T0",
"T1",
"T2",
"T3",
"T4+"
]
},
"description": "Optional. Bedroom counts wanted (T2 = two bedrooms)"
},
"intent": {
"type": "string",
"enum": [
"info",
"callback",
"visit",
"reserve",
"notify"
],
"description": "Optional. visit and reserve only with a project on sale, notify only with a project not yet on sale"
},
"preferred_time": {
"type": "string",
"maxLength": 120,
"description": "Optional, with intent=visit: when suits the person",
"examples": [
"weekday mornings"
]
},
"message": {
"type": "string",
"maxLength": 2000,
"description": "Optional. The person's own words",
"examples": [
"Close to the metro, with a balcony"
]
},
"client": {
"type": "string",
"description": "Optional. Your app's host or name: recorded as the request's source",
"examples": [
"claude.ai",
"chatgpt.com"
]
}
}
}