{ "info": { "title": "RELAND API", "version": "1.0.0", "description": "API RELAND para integrações internas e automações. Use Authorization: Bearer para acessar a spec protegida e chamar endpoints autenticados." }, "servers": [ { "url": "https://api.reland.com.br/rpc" } ], "openapi": "3.1.1", "paths": { "/ai/getStatus": { "post": { "operationId": "ai.getStatus", "summary": "ai get Status", "description": "Endpoint POST /ai/getStatus. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/getUser": { "post": { "operationId": "auth.getUser", "summary": "auth get User", "description": "Endpoint POST /auth/getUser. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/signInWithGoogle": { "post": { "operationId": "auth.signInWithGoogle", "summary": "auth sign In With Google", "description": "Endpoint POST /auth/signInWithGoogle. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "user": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "not": {} } } } }, "required": [ "token", "user" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/sendMagicLink": { "post": { "operationId": "auth.sendMagicLink", "summary": "auth send Magic Link", "description": "Endpoint POST /auth/sendMagicLink. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "redirectPath": { "type": "string" }, "user": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "not": {} } } } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/sendWhatsAppCode": { "post": { "operationId": "auth.sendWhatsAppCode", "summary": "auth send Whats App Code", "description": "Endpoint POST /auth/sendWhatsAppCode. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 4 }, "language": { "not": {} } }, "required": [ "phone" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/signInWithMagicLink": { "post": { "operationId": "auth.signInWithMagicLink", "summary": "auth sign In With Magic Link", "description": "Endpoint POST /auth/signInWithMagicLink. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "email": { "type": "string", "format": "email" }, "code": { "type": "string" }, "user": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "not": {} } } } }, "required": [ "user" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/signInWithWhatsAppCode": { "post": { "operationId": "auth.signInWithWhatsAppCode", "summary": "auth sign In With Whats App Code", "description": "Endpoint POST /auth/signInWithWhatsAppCode. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 4 }, "code": { "type": "string", "minLength": 4 }, "user": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "not": {} } } } }, "required": [ "phone", "code", "user" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/signOut": { "post": { "operationId": "auth.signOut", "summary": "auth sign Out", "description": "Endpoint POST /auth/signOut. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/pretaterra/getIdentity": { "post": { "operationId": "auth.pretaterra.getIdentity", "summary": "auth pretaterra get Identity", "description": "Endpoint POST /auth/pretaterra/getIdentity. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1 } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/pretaterra/sendEmailCode": { "post": { "operationId": "auth.pretaterra.sendEmailCode", "summary": "auth pretaterra send Email Code", "description": "Endpoint POST /auth/pretaterra/sendEmailCode. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/pretaterra/verifyEmailCode": { "post": { "operationId": "auth.pretaterra.verifyEmailCode", "summary": "auth pretaterra verify Email Code", "description": "Endpoint POST /auth/pretaterra/verifyEmailCode. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "code": { "type": "string", "minLength": 6, "maxLength": 6 } }, "required": [ "email", "code" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/pretaterra/sendWhatsAppCode": { "post": { "operationId": "auth.pretaterra.sendWhatsAppCode", "summary": "auth pretaterra send Whats App Code", "description": "Endpoint POST /auth/pretaterra/sendWhatsAppCode. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 4 }, "language": { "not": {} } }, "required": [ "phone" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/pretaterra/verifyWhatsAppCode": { "post": { "operationId": "auth.pretaterra.verifyWhatsAppCode", "summary": "auth pretaterra verify Whats App Code", "description": "Endpoint POST /auth/pretaterra/verifyWhatsAppCode. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 4 }, "code": { "type": "string", "minLength": 6, "maxLength": 6 } }, "required": [ "phone", "code" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/devLoginAsAdmin": { "post": { "operationId": "auth.devLoginAsAdmin", "summary": "auth dev Login As Admin", "description": "Endpoint POST /auth/devLoginAsAdmin. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/auth/impersonate": { "post": { "operationId": "auth.impersonate", "summary": "auth impersonate", "description": "Endpoint POST /auth/impersonate. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/articles/find": { "post": { "operationId": "articles.find", "summary": "articles find", "description": "Endpoint POST /articles/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "language": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" } }, "required": [ "slug" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/articles/list": { "post": { "operationId": "articles.list", "summary": "articles list", "description": "Endpoint POST /articles/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "language": { "type": "string" }, "limit": { "type": "number", "default": 12 }, "page": { "type": "number", "default": 1 }, "category": { "type": "string" }, "author": { "type": "string" }, "showAll": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/articles/listMore": { "post": { "operationId": "articles.listMore", "summary": "articles list More", "description": "Endpoint POST /articles/listMore. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "language": { "type": "string" }, "category": { "type": "string" } }, "required": [ "id", "language" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/currencies/list": { "post": { "operationId": "currencies.list", "summary": "currencies list", "description": "Endpoint POST /currencies/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/currencies/getByCode": { "post": { "operationId": "currencies.getByCode", "summary": "currencies get By Code", "description": "Endpoint POST /currencies/getByCode. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/currencies/getRates": { "post": { "operationId": "currencies.getRates", "summary": "currencies get Rates", "description": "Endpoint POST /currencies/getRates. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/listHomepage": { "post": { "operationId": "listings.listHomepage", "summary": "listings list Homepage", "description": "Endpoint POST /listings/listHomepage. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/list": { "post": { "operationId": "listings.list", "summary": "listings list", "description": "Endpoint POST /listings/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "boolean" } ] } }, "required": [ "id" ] }, "default": [] }, "filterType": { "enum": [ "and", "or" ], "type": "string", "default": "and" }, "orderBy": { "enum": [ "relevant", "area-asc", "area-desc", "price-asc", "price-desc", "newest", "oldest", "lowest-price-area", "highest-price-area" ], "type": "string", "default": "relevant" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 24 }, "includeTotal": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/find": { "post": { "operationId": "listings.find", "summary": "listings find", "description": "Endpoint POST /listings/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "allowOffMarket": { "type": "boolean", "default": false } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/create": { "post": { "operationId": "listings.create", "summary": "listings create", "description": "Endpoint POST /listings/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "broker_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "car": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "property_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_translations": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_source_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_generated_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "type": { "anyOf": [ { "enum": [ "country-home", "small-farm", "farm", "stud-farm", "plot", "cottage", "city-house", "apartment", "commercial", "lodging", "development", "island", "eco-village", "mining" ], "type": "string" }, { "type": "null" } ] }, "area": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency_unit_source": { "type": "string" }, "negotiation_min_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "accepted_payment_methods": { "type": "array", "items": { "enum": [ "cash", "financing", "bitcoin", "usd", "soy_bags", "gemstone", "exchange", "other" ], "type": "string" } }, "accepted_payment_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rental_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "for_exchange": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "exchange_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commission": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "country_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "state_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "city_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "district": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "neighborhood": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "coordinates": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lat": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "string" } }, "video": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "documents": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "polygon_geojson": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, { "type": "null" } ] }, "status": { "enum": [ "draft", "pending", "published", "off_market", "paused", "rejected", "duplicated", "approved", "suspicious", "removed", "integrated", "sold" ], "type": "string" }, "for_sale": { "type": "boolean" }, "for_rent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "for_auction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "image_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_relationship_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "property_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "priority_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "details": { "anyOf": [ { "type": "object", "properties": { "building_area": { "type": "number", "exclusiveMinimum": 0 }, "exchange": { "type": "boolean" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } }, "development": { "type": "object", "properties": { "category": { "enum": [ "gated_lot_community", "masterplan", "vertical_residential", "condohotel", "mixed_use" ], "type": "string" }, "total_area_m2": { "type": "number", "exclusiveMinimum": 0 }, "total_units": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "neighborhoods_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "amenities": { "type": "array", "items": { "enum": [ "controlled_access", "security_24h", "clubhouse", "crystal_lagoon", "white_sand_beach", "marina", "sports_courts", "gym", "pool", "playground", "walking_trails", "hotel_services" ], "type": "string" }, "default": [] }, "offerings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "enum": [ "plot", "studio", "apartment", "penthouse", "other" ], "type": "string" }, "area_from_m2": { "type": "number", "exclusiveMinimum": 0 }, "price_from": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 } }, "required": [ "name", "kind" ] }, "default": [] } }, "required": [ "category" ] } } }, { "type": "null" } ] }, "verified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_relationship": { "anyOf": [ { "enum": [ "owner", "relative", "direct_broker", "partner_broker" ], "type": "string" }, { "type": "null" } ] }, "reason_not_approved": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_rejection_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_audit_log": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "language_source": { "type": "string" }, "description_verified": { "type": "boolean" }, "old_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "images_migration_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cultivable_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "reserved_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "exposure": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "views": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "favorites_count": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "posted": { "type": "boolean" }, "satellite_video": { "type": "boolean" }, "marketing_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ad_origin": { "anyOf": [ { "enum": [ "advertise_site_forms", "whatsapp", "integration" ], "type": "string" }, { "type": "null" } ] }, "plan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "listing_pipeline_stage_key": { "anyOf": [ { "enum": [ "prospecting", "material_collection", "evaluation", "script", "video", "dispatch", "paid_traffic", "concluded" ], "type": "string" }, { "type": "null" } ] }, "draft_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "plan_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "embedding": { "anyOf": [ { "type": "array", "minItems": 1536, "maxItems": 1536, "items": { "type": "number" } }, { "type": "null" } ] }, "description": { "type": "string" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } } }, "required": [ "area" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/update": { "post": { "operationId": "listings.update", "summary": "listings update", "description": "Endpoint POST /listings/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "broker_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "car": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "property_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_translations": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_source_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_generated_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "type": { "anyOf": [ { "enum": [ "country-home", "small-farm", "farm", "stud-farm", "plot", "cottage", "city-house", "apartment", "commercial", "lodging", "development", "island", "eco-village", "mining" ], "type": "string" }, { "type": "null" } ] }, "area": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency_unit_source": { "type": "string" }, "negotiation_min_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "accepted_payment_methods": { "type": "array", "items": { "enum": [ "cash", "financing", "bitcoin", "usd", "soy_bags", "gemstone", "exchange", "other" ], "type": "string" } }, "accepted_payment_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rental_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "for_exchange": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "exchange_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commission": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "country_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "state_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "city_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "district": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "neighborhood": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "coordinates": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lat": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "string" } }, "video": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "documents": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "polygon_geojson": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, { "type": "null" } ] }, "status": { "enum": [ "draft", "pending", "paused", "published", "off_market", "duplicated" ], "type": "string" }, "for_sale": { "type": "boolean" }, "for_rent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "for_auction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "image_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_relationship_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "property_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "priority_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "details": { "anyOf": [ { "type": "object", "properties": { "building_area": { "type": "number", "exclusiveMinimum": 0 }, "exchange": { "type": "boolean" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } }, "development": { "type": "object", "properties": { "category": { "enum": [ "gated_lot_community", "masterplan", "vertical_residential", "condohotel", "mixed_use" ], "type": "string" }, "total_area_m2": { "type": "number", "exclusiveMinimum": 0 }, "total_units": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "neighborhoods_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "amenities": { "type": "array", "items": { "enum": [ "controlled_access", "security_24h", "clubhouse", "crystal_lagoon", "white_sand_beach", "marina", "sports_courts", "gym", "pool", "playground", "walking_trails", "hotel_services" ], "type": "string" }, "default": [] }, "offerings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "enum": [ "plot", "studio", "apartment", "penthouse", "other" ], "type": "string" }, "area_from_m2": { "type": "number", "exclusiveMinimum": 0 }, "price_from": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 } }, "required": [ "name", "kind" ] }, "default": [] } }, "required": [ "category" ] } } }, { "type": "null" } ] }, "verified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_relationship": { "anyOf": [ { "enum": [ "owner", "relative", "direct_broker", "partner_broker" ], "type": "string" }, { "type": "null" } ] }, "reason_not_approved": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_rejection_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_audit_log": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "language_source": { "type": "string" }, "description_verified": { "type": "boolean" }, "old_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "images_migration_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cultivable_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "reserved_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "exposure": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "views": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "favorites_count": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "posted": { "type": "boolean" }, "satellite_video": { "type": "boolean" }, "marketing_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ad_origin": { "anyOf": [ { "enum": [ "advertise_site_forms", "whatsapp", "integration" ], "type": "string" }, { "type": "null" } ] }, "plan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "listing_pipeline_stage_key": { "anyOf": [ { "enum": [ "prospecting", "material_collection", "evaluation", "script", "video", "dispatch", "paid_traffic", "concluded" ], "type": "string" }, { "type": "null" } ] }, "draft_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "plan_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "embedding": { "anyOf": [ { "type": "array", "minItems": 1536, "maxItems": 1536, "items": { "type": "number" } }, { "type": "null" } ] }, "description": { "type": "string" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/updateDraft": { "post": { "operationId": "listings.updateDraft", "summary": "listings update Draft", "description": "Endpoint POST /listings/updateDraft. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "broker_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "car": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "property_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_translations": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_source_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_generated_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "type": { "anyOf": [ { "enum": [ "country-home", "small-farm", "farm", "stud-farm", "plot", "cottage", "city-house", "apartment", "commercial", "lodging", "development", "island", "eco-village", "mining" ], "type": "string" }, { "type": "null" } ] }, "area": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency_unit_source": { "type": "string" }, "negotiation_min_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "accepted_payment_methods": { "type": "array", "items": { "enum": [ "cash", "financing", "bitcoin", "usd", "soy_bags", "gemstone", "exchange", "other" ], "type": "string" } }, "accepted_payment_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rental_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "for_exchange": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "exchange_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commission": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "country_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "state_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "city_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "district": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "neighborhood": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "coordinates": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lat": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "string" } }, "video": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "documents": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "polygon_geojson": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, { "type": "null" } ] }, "status": { "enum": [ "draft", "pending", "paused", "published", "off_market", "duplicated" ], "type": "string" }, "for_sale": { "type": "boolean" }, "for_rent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "for_auction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "image_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_relationship_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "property_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "priority_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "details": { "anyOf": [ { "type": "object", "properties": { "building_area": { "type": "number", "exclusiveMinimum": 0 }, "exchange": { "type": "boolean" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } }, "development": { "type": "object", "properties": { "category": { "enum": [ "gated_lot_community", "masterplan", "vertical_residential", "condohotel", "mixed_use" ], "type": "string" }, "total_area_m2": { "type": "number", "exclusiveMinimum": 0 }, "total_units": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "neighborhoods_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "amenities": { "type": "array", "items": { "enum": [ "controlled_access", "security_24h", "clubhouse", "crystal_lagoon", "white_sand_beach", "marina", "sports_courts", "gym", "pool", "playground", "walking_trails", "hotel_services" ], "type": "string" }, "default": [] }, "offerings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "enum": [ "plot", "studio", "apartment", "penthouse", "other" ], "type": "string" }, "area_from_m2": { "type": "number", "exclusiveMinimum": 0 }, "price_from": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 } }, "required": [ "name", "kind" ] }, "default": [] } }, "required": [ "category" ] } } }, { "type": "null" } ] }, "verified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_relationship": { "anyOf": [ { "enum": [ "owner", "relative", "direct_broker", "partner_broker" ], "type": "string" }, { "type": "null" } ] }, "reason_not_approved": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_rejection_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_audit_log": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "language_source": { "type": "string" }, "description_verified": { "type": "boolean" }, "old_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "images_migration_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cultivable_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "reserved_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "exposure": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "views": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "favorites_count": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "posted": { "type": "boolean" }, "satellite_video": { "type": "boolean" }, "marketing_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ad_origin": { "anyOf": [ { "enum": [ "advertise_site_forms", "whatsapp", "integration" ], "type": "string" }, { "type": "null" } ] }, "plan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "listing_pipeline_stage_key": { "anyOf": [ { "enum": [ "prospecting", "material_collection", "evaluation", "script", "video", "dispatch", "paid_traffic", "concluded" ], "type": "string" }, { "type": "null" } ] }, "draft_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "plan_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "embedding": { "anyOf": [ { "type": "array", "minItems": 1536, "maxItems": 1536, "items": { "type": "number" } }, { "type": "null" } ] }, "description": { "type": "string" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/imageAnalysis/status": { "post": { "operationId": "listings.imageAnalysis.status", "summary": "listings image Analysis status", "description": "Endpoint POST /listings/imageAnalysis/status. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string", "minLength": 1 } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/imageAnalysis/metadata": { "post": { "operationId": "listings.imageAnalysis.metadata", "summary": "listings image Analysis metadata", "description": "Endpoint POST /listings/imageAnalysis/metadata. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string", "minLength": 1 } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/imageAnalysis/classify": { "post": { "operationId": "listings.imageAnalysis.classify", "summary": "listings image Analysis classify", "description": "Endpoint POST /listings/imageAnalysis/classify. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string", "minLength": 1 }, "imageIds": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 } }, "model": { "enum": [ "gemini-2.5-flash-lite", "gemini-3.1-flash-lite" ], "type": "string", "default": "gemini-2.5-flash-lite" } }, "required": [ "listingId", "imageIds" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/imageAnalysis/suggest": { "post": { "operationId": "listings.imageAnalysis.suggest", "summary": "listings image Analysis suggest", "description": "Endpoint POST /listings/imageAnalysis/suggest. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string", "minLength": 1 }, "model": { "enum": [ "gemini-2.5-flash-lite", "gemini-3.1-flash-lite" ], "type": "string", "default": "gemini-2.5-flash-lite" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/imageAnalysis/apply": { "post": { "operationId": "listings.imageAnalysis.apply", "summary": "listings image Analysis apply", "description": "Endpoint POST /listings/imageAnalysis/apply. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string", "minLength": 1 }, "analysisRunId": { "type": "string", "minLength": 1 } }, "required": [ "listingId", "analysisRunId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/listMore": { "post": { "operationId": "listings.listMore", "summary": "listings list More", "description": "Endpoint POST /listings/listMore. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/findGroup": { "post": { "operationId": "listings.findGroup", "summary": "listings find Group", "description": "Endpoint POST /listings/findGroup. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/presentation/get": { "post": { "operationId": "listings.presentation.get", "summary": "listings presentation get", "description": "Endpoint POST /listings/presentation/get. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/complaint": { "post": { "operationId": "listings.complaint", "summary": "listings complaint", "description": "Endpoint POST /listings/complaint. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "listingId", "reason" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/analytics/view": { "post": { "operationId": "listings.analytics.view", "summary": "listings analytics view", "description": "Endpoint POST /listings/analytics/view. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/analytics/exposure": { "post": { "operationId": "listings.analytics.exposure", "summary": "listings analytics exposure", "description": "Endpoint POST /listings/analytics/exposure. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingsId": { "type": "array", "items": { "type": "string" } }, "source": { "enum": [ "properties_search", "homepage", "listing_group", "property_detail", "unknown" ], "type": "string" }, "path": { "type": "string", "maxLength": 500 }, "sessionHash": { "type": "string", "maxLength": 128 } }, "required": [ "listingsId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/search/createAlert": { "post": { "operationId": "listings.search.createAlert", "summary": "listings search create Alert", "description": "Endpoint POST /listings/search/createAlert. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "id", "value" ] } } }, "required": [ "title", "filters" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/search/record": { "post": { "operationId": "listings.search.record", "summary": "listings search record", "description": "Endpoint POST /listings/search/record. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 300 }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "id", "value" ] } }, "orderBy": { "enum": [ "relevant", "area-asc", "area-desc", "price-asc", "price-desc", "newest", "oldest", "lowest-price-area", "highest-price-area" ], "type": "string", "default": "relevant" } }, "required": [ "title", "filters" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/search/list": { "post": { "operationId": "listings.search.list", "summary": "listings search list", "description": "Endpoint POST /listings/search/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/search/delete": { "post": { "operationId": "listings.search.delete", "summary": "listings search delete", "description": "Endpoint POST /listings/search/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/search/semantic": { "post": { "operationId": "listings.search.semantic", "summary": "listings search semantic", "description": "Endpoint POST /listings/search/semantic. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 3, "maxLength": 1000 }, "limit": { "type": "number", "default": 12 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/chat/ask": { "post": { "operationId": "listings.chat.ask", "summary": "listings chat ask", "description": "Endpoint POST /listings/chat/ask. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "message": { "type": "string", "minLength": 1, "maxLength": 500 }, "sessionId": { "type": "string" }, "history": { "type": "array", "items": { "type": "object", "properties": { "role": { "enum": [ "user", "assistant" ], "type": "string" }, "content": { "type": "string" } }, "required": [ "role", "content" ] }, "default": [] } }, "required": [ "listingId", "message" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/aiSummary/generate": { "post": { "operationId": "listings.aiSummary.generate", "summary": "listings ai Summary generate", "description": "Endpoint POST /listings/aiSummary/generate. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/description/find": { "post": { "operationId": "listings.description.find", "summary": "listings description find", "description": "Endpoint POST /listings/description/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "language": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" } }, "required": [ "listingId", "language" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/description/audit": { "post": { "operationId": "listings.description.audit", "summary": "listings description audit", "description": "Endpoint POST /listings/description/audit. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/listings/description/improve": { "post": { "operationId": "listings.description.improve", "summary": "listings description improve", "description": "Endpoint POST /listings/description/improve. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "improve": { "type": "boolean" } }, "required": [ "description", "improve" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/list": { "post": { "operationId": "regions.list", "summary": "regions list", "description": "Endpoint POST /regions/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "string" }, "limit": { "type": "number", "default": 10 }, "page": { "type": "number", "default": 1 }, "locale": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" }, "includeTotal": { "type": "boolean", "default": false }, "type": { "enum": [ "country", "state", "city", "subregion", "region", "biome" ], "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "minListings": { "type": "number" }, "prioritySlugs": { "type": "array", "maxItems": 20, "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/find": { "post": { "operationId": "regions.find", "summary": "regions find", "description": "Endpoint POST /regions/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "locale": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/listByCity": { "post": { "operationId": "regions.listByCity", "summary": "regions list By City", "description": "Endpoint POST /regions/listByCity. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "country", "state", "city", "subregion", "region", "biome" ], "type": "string" }, "cityId": { "type": "number" }, "locale": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" } }, "required": [ "cityId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/getLocationContext": { "post": { "operationId": "regions.getLocationContext", "summary": "regions get Location Context", "description": "Endpoint POST /regions/getLocationContext. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cityId": { "type": "number" }, "locale": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" } }, "required": [ "cityId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/listByListingType": { "post": { "operationId": "regions.listByListingType", "summary": "regions list By Listing Type", "description": "Endpoint POST /regions/listByListingType. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "string" }, "minListings": { "type": "number" }, "limit": { "type": "number" }, "page": { "type": "number", "default": 1 }, "locale": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" } }, "required": [ "limit" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/listClose": { "post": { "operationId": "regions.listClose", "summary": "regions list Close", "description": "Endpoint POST /regions/listClose. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "region": { "type": "object", "properties": { "slug": { "type": "string" }, "lat": { "type": "number" }, "lng": { "type": "number" } }, "required": [ "slug", "lat", "lng" ] } }, "required": [ "region" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/resolveGeometry": { "post": { "operationId": "regions.resolveGeometry", "summary": "regions resolve Geometry", "description": "Endpoint POST /regions/resolveGeometry. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "geometry": { "type": "object", "properties": { "type": { "enum": [ "Polygon", "MultiPolygon" ], "type": "string" }, "coordinates": { "type": "array", "minItems": 1, "items": {} } }, "required": [ "type", "coordinates" ] } }, "required": [ "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/analyzeTerrain": { "post": { "operationId": "regions.analyzeTerrain", "summary": "regions analyze Terrain", "description": "Endpoint POST /regions/analyzeTerrain. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "geometry": { "type": "object", "properties": { "type": { "enum": [ "Polygon", "MultiPolygon" ], "type": "string" }, "coordinates": { "type": "array", "minItems": 1, "items": {} } }, "required": [ "type", "coordinates" ] } }, "required": [ "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/refresh": { "post": { "operationId": "regions.refresh", "summary": "regions refresh", "description": "Endpoint POST /regions/refresh. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/regions/city/list": { "post": { "operationId": "regions.city.list", "summary": "regions city list", "description": "Endpoint POST /regions/city/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string" } }, "required": [ "state" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/maps/markers/list": { "post": { "operationId": "maps.markers.list", "summary": "maps markers list", "description": "Endpoint POST /maps/markers/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "zoom": { "type": "number" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "boolean" } ] } }, "required": [ "id" ] }, "default": [] } }, "required": [ "zoom" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/list": { "post": { "operationId": "collections.list", "summary": "collections list", "description": "Endpoint POST /collections/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/find": { "post": { "operationId": "collections.find", "summary": "collections find", "description": "Endpoint POST /collections/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionId": { "type": "string" }, "limit": { "type": "number", "default": 24 }, "page": { "type": "number", "default": 1 } }, "required": [ "collectionId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/create": { "post": { "operationId": "collections.create", "summary": "collections create", "description": "Endpoint POST /collections/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "listingId": { "type": "string" } }, "required": [ "name", "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/update": { "post": { "operationId": "collections.update", "summary": "collections update", "description": "Endpoint POST /collections/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/delete": { "post": { "operationId": "collections.delete", "summary": "collections delete", "description": "Endpoint POST /collections/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionId": { "type": "string" } }, "required": [ "collectionId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/favorites/find": { "post": { "operationId": "collections.favorites.find", "summary": "collections favorites find", "description": "Endpoint POST /collections/favorites/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/favorites/list": { "post": { "operationId": "collections.favorites.list", "summary": "collections favorites list", "description": "Endpoint POST /collections/favorites/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/favorites/create": { "post": { "operationId": "collections.favorites.create", "summary": "collections favorites create", "description": "Endpoint POST /collections/favorites/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "collectionId": { "type": "string" } }, "required": [ "listingId", "collectionId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/collections/favorites/delete": { "post": { "operationId": "collections.favorites.delete", "summary": "collections favorites delete", "description": "Endpoint POST /collections/favorites/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "collectionId": { "type": "string" } }, "required": [ "listingId", "collectionId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/deals/create": { "post": { "operationId": "deals.create", "summary": "deals create", "description": "Endpoint POST /deals/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "type": "string" }, "listing_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "phone", "listing_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/proposals/create": { "post": { "operationId": "proposals.create", "summary": "proposals create", "description": "Endpoint POST /proposals/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "value": { "type": "number" }, "currency": { "type": "string", "default": "BRL" }, "paymentMethod": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "listingId", "value", "paymentMethod" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/proposals/update": { "post": { "operationId": "proposals.update", "summary": "proposals update", "description": "Endpoint POST /proposals/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "authored_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, "currency": { "type": "string" }, "payment_method": { "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/proposals/listReceived": { "post": { "operationId": "proposals.listReceived", "summary": "proposals list Received", "description": "Endpoint POST /proposals/listReceived. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/proposals/listMine": { "post": { "operationId": "proposals.listMine", "summary": "proposals list Mine", "description": "Endpoint POST /proposals/listMine. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/visits/create": { "post": { "operationId": "visits.create", "summary": "visits create", "description": "Endpoint POST /visits/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "date": { "type": "string" }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "listingId", "date" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/visits/update": { "post": { "operationId": "visits.update", "summary": "visits update", "description": "Endpoint POST /visits/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "date": { "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/advertisers/list": { "get": { "operationId": "advertisers.list", "summary": "advertisers list", "description": "Endpoint GET /advertisers/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/advertisers/find": { "post": { "operationId": "advertisers.find", "summary": "advertisers find", "description": "Endpoint POST /advertisers/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" } }, "required": [ "slug" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/leads/services/create": { "post": { "operationId": "leads.services.create", "summary": "leads services create", "description": "Endpoint POST /leads/services/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "contacted_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "form": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "area": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "valuation_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priority": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purpose": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "broker_responsible_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/leads/buyer/create": { "post": { "operationId": "leads.buyer.create", "summary": "leads buyer create", "description": "Endpoint POST /leads/buyer/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "filters": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "order_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "search_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authored_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alert": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "created_from": { "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tasks": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purchase_power": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "priority": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "contacted_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "follow_up_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "type": "string" }, "area": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "budget": { "type": "string" }, "area_min": { "type": "string" }, "area_max": { "type": "string" }, "area_unit": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/landPrices/compareListing": { "post": { "operationId": "landPrices.compareListing", "summary": "land Prices compare Listing", "description": "Endpoint POST /landPrices/compareListing. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "average_price_per_hectare": { "type": "number" }, "max_price_per_hectare": { "type": "number" }, "min_price_per_hectare": { "type": "number" }, "price_per_hectare": { "type": "number" }, "region_name": { "type": "string" }, "total": { "type": "number" } }, "required": [ "average_price_per_hectare", "max_price_per_hectare", "min_price_per_hectare", "price_per_hectare", "region_name", "total" ] }, { "type": "null" } ] } } } } } } }, "/landPrices/find": { "post": { "operationId": "landPrices.find", "summary": "land Prices find", "description": "Endpoint POST /landPrices/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "region": { "type": "object", "properties": { "lat": { "type": "number" }, "lng": { "type": "number" }, "slug": { "type": "string" }, "type": { "enum": [ "country", "state", "city", "subregion", "region", "biome" ], "type": "string" }, "cities": { "type": "array", "items": { "type": "number" } } }, "required": [ "lat", "lng", "slug", "type", "cities" ] }, "type": { "enum": [ "country-home", "small-farm", "farm", "stud-farm", "plot", "cottage", "city-house", "apartment", "commercial", "lodging", "development", "island", "eco-village", "mining", "all" ], "type": "string" } }, "required": [ "region" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/pretaterra-finance/:slug": { "get": { "operationId": "landPrices.pretaterraFinance", "summary": "land Prices pretaterra Finance", "description": "Endpoint GET /pretaterra-finance/:slug. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "parameters": [ { "name": "slug", "in": "query", "required": true, "schema": { "type": "string" }, "allowEmptyValue": true, "allowReserved": true }, { "name": "locale", "in": "query", "required": false, "schema": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" }, "allowEmptyValue": true, "allowReserved": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "average_price_per_area_m2": { "type": "number" }, "average_price_per_hectare": { "type": "number" }, "max_price_per_hectare": { "type": "number" }, "min_price_per_hectare": { "type": "number" }, "total": { "type": "number" } }, "required": [ "average_price_per_area_m2", "average_price_per_hectare", "max_price_per_hectare", "min_price_per_hectare", "total" ] }, { "type": "null" } ] } } } } } } }, "/sitemap/page/get": { "post": { "operationId": "sitemap.page.get", "summary": "sitemap page get", "description": "Endpoint POST /sitemap/page/get. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" }, "pageType": { "type": "string" }, "page": { "type": "number", "default": 1 } }, "required": [ "pageType" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/update": { "post": { "operationId": "account.update", "summary": "account update", "description": "Endpoint POST /account/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "anyOf": [ { "not": {} }, { "type": "null" } ] }, "role": { "enum": [ "admin", "user", "partner" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram_handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_role": { "anyOf": [ { "enum": [ "admin", "assessor" ], "type": "string" }, { "type": "null" } ] }, "can_be_responsible": { "type": "boolean" }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser": { "type": "boolean" }, "advertiser_homepage": { "type": "boolean" }, "advertiser_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_portal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_integration_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_synced_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "terms_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cpf": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "automated_response": { "type": "boolean" }, "attendance_status": { "enum": [ "new", "no_reply", "follow_up", "automation", "paused", "ignore" ], "type": "string" }, "flow_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message_to_send": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "whatsapp_lid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "whatsapp_jid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_intermediary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purchase_power": { "anyOf": [ { "type": "number", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "contacted_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "follow_up_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "last_login_ip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_country_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_region_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_region_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_latitude": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "last_login_longitude": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "last_login_asn": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "last_login_org": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "old_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lead_score": { "type": "number", "minimum": -8388608, "maximum": 8388607 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/getUploadPictureUrl": { "post": { "operationId": "account.getUploadPictureUrl", "summary": "account get Upload Picture Url", "description": "Endpoint POST /account/getUploadPictureUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/phone/sendVerification": { "post": { "operationId": "account.phone.sendVerification", "summary": "account phone send Verification", "description": "Endpoint POST /account/phone/sendVerification. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string" } }, "required": [ "phone" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/phone/verify": { "post": { "operationId": "account.phone.verify", "summary": "account phone verify", "description": "Endpoint POST /account/phone/verify. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string" }, "pin": { "type": "string" } }, "required": [ "phone", "pin" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/history/list": { "post": { "operationId": "account.history.list", "summary": "account history list", "description": "Endpoint POST /account/history/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "number", "default": 1 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/deals/list": { "post": { "operationId": "account.deals.list", "summary": "account deals list", "description": "Endpoint POST /account/deals/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "number", "default": 1 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/services/requestConsorcio": { "post": { "operationId": "account.services.requestConsorcio", "summary": "account services request Consorcio", "description": "Endpoint POST /account/services/requestConsorcio. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "creditValue": { "type": "string" }, "entryValue": { "type": "string" }, "objective": { "type": "string", "minLength": 2 }, "phone": { "type": "string" }, "origin": { "type": "string" } }, "required": [ "creditValue", "entryValue", "objective" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/apiToken/get": { "post": { "operationId": "account.apiToken.get", "summary": "Ler token de API", "description": "Retorna se o usuário autenticado possui um token de API ativo e, se existir, a data de criação.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/apiToken/generate": { "post": { "operationId": "account.apiToken.generate", "summary": "Gerar token de API", "description": "Gera um novo token de API para o usuário autenticado e substitui o token anterior.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/apiToken/revoke": { "post": { "operationId": "account.apiToken.revoke", "summary": "Revogar token de API", "description": "Revoga o token de API do usuário autenticado e deixa a conta sem token ativo.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/requestDocument": { "post": { "operationId": "account.listings.requestDocument", "summary": "account listings request Document", "description": "Endpoint POST /account/listings/requestDocument. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "listingTitle": { "type": "string" }, "listingLink": { "type": "string" } }, "required": [ "listingId", "listingTitle", "listingLink" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/requestFinance": { "post": { "operationId": "account.listings.requestFinance", "summary": "account listings request Finance", "description": "Endpoint POST /account/listings/requestFinance. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "listingTitle": { "type": "string" }, "listingLink": { "type": "string" } }, "required": [ "listingId", "listingTitle", "listingLink" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/find": { "post": { "operationId": "account.listings.find", "summary": "account listings find", "description": "Endpoint POST /account/listings/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "draft": { "type": "boolean" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/list": { "post": { "operationId": "account.listings.list", "summary": "account listings list", "description": "Endpoint POST /account/listings/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 24 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/assets/uploadImageUrl": { "post": { "operationId": "account.listings.assets.uploadImageUrl", "summary": "account listings assets upload Image Url", "description": "Endpoint POST /account/listings/assets/uploadImageUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/assets/uploadVideoUrl": { "post": { "operationId": "account.listings.assets.uploadVideoUrl", "summary": "account listings assets upload Video Url", "description": "Endpoint POST /account/listings/assets/uploadVideoUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "fileName": { "type": "string" } }, "required": [ "listingId", "fileName" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/assets/uploadDocumentUrl": { "post": { "operationId": "account.listings.assets.uploadDocumentUrl", "summary": "account listings assets upload Document Url", "description": "Endpoint POST /account/listings/assets/uploadDocumentUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "fileName": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/assets/documentUrl": { "post": { "operationId": "account.listings.assets.documentUrl", "summary": "account listings assets document Url", "description": "Endpoint POST /account/listings/assets/documentUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "fileName": { "type": "string" } }, "required": [ "listingId", "fileName" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/assets/list": { "post": { "operationId": "account.listings.assets.list", "summary": "account listings assets list", "description": "Endpoint POST /account/listings/assets/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/assets/add": { "post": { "operationId": "account.listings.assets.add", "summary": "account listings assets add", "description": "Endpoint POST /account/listings/assets/add. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "fileId": { "type": "string" }, "fileName": { "type": "string" }, "type": { "enum": [ "presentation", "deed", "environmental_registry", "tax_id", "geospatial", "other" ], "type": "string" }, "size": { "type": "number" }, "mimeType": { "type": "string" }, "isPublic": { "type": "boolean" } }, "required": [ "listingId", "fileId", "fileName", "type" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/assets/delete": { "post": { "operationId": "account.listings.assets.delete", "summary": "account listings assets delete", "description": "Endpoint POST /account/listings/assets/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/listings/assets/update": { "post": { "operationId": "account.listings.assets.update", "summary": "account listings assets update", "description": "Endpoint POST /account/listings/assets/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isPublic": { "type": "boolean" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/visits/list": { "post": { "operationId": "account.visits.list", "summary": "account visits list", "description": "Endpoint POST /account/visits/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/account/visits/update": { "post": { "operationId": "account.visits.update", "summary": "account visits update", "description": "Endpoint POST /account/visits/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "deal_id": { "type": "string" }, "authored_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date": { "type": "string" }, "time": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ] }, "status": { "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/payments/mercadoPago/listingAdPlan/create": { "post": { "operationId": "payments.mercadoPago.listingAdPlan.create", "summary": "payments mercado Pago listing Ad Plan create", "description": "Endpoint POST /payments/mercadoPago/listingAdPlan/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listing_id": { "type": "string" }, "plan": { "type": "string" } }, "required": [ "listing_id", "plan" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/payments/abacatePay/listingAdPlan/create": { "post": { "operationId": "payments.abacatePay.listingAdPlan.create", "summary": "payments abacate Pay listing Ad Plan create", "description": "Endpoint POST /payments/abacatePay/listingAdPlan/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listing_id": { "type": "string" }, "plan": { "type": "string" } }, "required": [ "listing_id", "plan" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/payments/abacatePay/listingAdPlan/webhook": { "post": { "operationId": "payments.abacatePay.listingAdPlan.webhook", "summary": "payments abacate Pay listing Ad Plan webhook", "description": "Endpoint POST /payments/abacatePay/listingAdPlan/webhook. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/payments/listingAdPlan/create": { "post": { "operationId": "payments.listingAdPlan.create", "summary": "payments listing Ad Plan create", "description": "Endpoint POST /payments/listingAdPlan/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listing_id": { "type": "string" }, "plan": { "type": "string" } }, "required": [ "listing_id", "plan" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/payments/listingReport/create": { "post": { "operationId": "payments.listingReport.create", "summary": "payments listing Report create", "description": "Endpoint POST /payments/listingReport/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "plan": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "plan" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/payments/asaasSandbox/create": { "post": { "operationId": "payments.asaasSandbox.create", "summary": "payments asaas Sandbox create", "description": "Endpoint POST /payments/asaasSandbox/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listing_id": { "type": "string" }, "product_kind": { "enum": [ "report", "ad_plan" ], "type": "string" }, "plan_id": { "type": "string" }, "billing_type": { "enum": [ "CREDIT_CARD", "BOLETO" ], "type": "string", "default": "CREDIT_CARD" } }, "required": [ "listing_id", "product_kind", "plan_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/payments/asaasSandbox/get": { "post": { "operationId": "payments.asaasSandbox.get", "summary": "payments asaas Sandbox get", "description": "Endpoint POST /payments/asaasSandbox/get. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "order_id": { "type": "string" } }, "required": [ "order_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/instagramLinks/resolve": { "post": { "operationId": "instagramLinks.resolve", "summary": "instagram Links resolve", "description": "Endpoint POST /instagramLinks/resolve. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 } }, "required": [ "token" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/instagramBio/list": { "post": { "operationId": "instagramBio.list", "summary": "instagram Bio list", "description": "Endpoint POST /instagramBio/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 48, "default": 12 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/agriculturalCommodities/list": { "post": { "operationId": "agriculturalCommodities.list", "summary": "agricultural Commodities list", "description": "Endpoint POST /agriculturalCommodities/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/soil/analyze": { "post": { "operationId": "soil.analyze", "summary": "soil analyze", "description": "Endpoint POST /soil/analyze. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "geometry": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "Polygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } }, "required": [ "type", "coordinates" ] }, { "type": "object", "properties": { "type": { "const": "MultiPolygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } } }, "required": [ "type", "coordinates" ] } ] } }, "required": [ "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/soil/getAnalysis": { "post": { "operationId": "soil.getAnalysis", "summary": "soil get Analysis", "description": "Endpoint POST /soil/getAnalysis. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "analysisId": { "type": "string", "minLength": 1 } }, "required": [ "analysisId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/soil/processorCallback": { "post": { "operationId": "soil.processorCallback", "summary": "soil processor Callback", "description": "Endpoint POST /soil/processorCallback. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "analysisId": { "type": "string", "minLength": 1 }, "status": { "enum": [ "complete", "partial", "failed" ], "type": "string" }, "signature": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "provider": { "const": "SoilGrids" }, "source_version": { "type": "string", "minLength": 1 }, "resolution_meters": { "type": "number", "exclusiveMinimum": 0 }, "pixel_selection": { "const": "center" }, "disclaimer": { "type": "object", "properties": { "code": { "const": "territorial_estimate_not_laboratory_analysis" } }, "required": [ "code" ] }, "properties": { "type": "array", "items": { "type": "object", "properties": { "property_id": { "enum": [ "phh2o", "cec", "soc", "nitrogen", "clay", "sand", "silt", "cfvo", "bdod" ], "type": "string" }, "unit": { "type": "string", "minLength": 1 }, "conversion_factor": { "type": "number", "exclusiveMinimum": 0 }, "depths": { "type": "array", "items": { "type": "object", "properties": { "depth_id": { "enum": [ "0-5cm", "5-15cm", "15-30cm" ], "type": "string" }, "coverage_ids": { "type": "object", "properties": { "q05": { "type": "string", "minLength": 1 }, "q50": { "type": "string", "minLength": 1 }, "q95": { "type": "string", "minLength": 1 } }, "required": [ "q05", "q50", "q95" ] }, "coverages": { "type": "object", "properties": { "q05": { "type": "object", "properties": { "min": { "type": "number" }, "median": { "type": "number" }, "max": { "type": "number" }, "valid_pixel_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "min", "median", "max", "valid_pixel_count" ] }, "q50": { "type": "object", "properties": { "min": { "type": "number" }, "median": { "type": "number" }, "max": { "type": "number" }, "valid_pixel_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "min", "median", "max", "valid_pixel_count" ] }, "q95": { "type": "object", "properties": { "min": { "type": "number" }, "median": { "type": "number" }, "max": { "type": "number" }, "valid_pixel_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "min", "median", "max", "valid_pixel_count" ] } }, "required": [ "q05", "q50", "q95" ] }, "uncertainty": { "type": "object", "properties": { "lower": { "type": "number" }, "upper": { "type": "number" }, "width": { "type": "number", "minimum": 0 } }, "required": [ "lower", "upper", "width" ] } }, "required": [ "depth_id", "coverage_ids", "coverages", "uncertainty" ] } } }, "required": [ "property_id", "unit", "conversion_factor", "depths" ] } }, "failures": { "type": "array", "items": { "type": "object", "properties": { "property_id": { "enum": [ "phh2o", "cec", "soc", "nitrogen", "clay", "sand", "silt", "cfvo", "bdod" ], "type": "string" }, "depth_id": { "enum": [ "0-5cm", "5-15cm", "15-30cm" ], "type": "string" }, "quantile_id": { "enum": [ "q05", "q50", "q95" ], "type": "string" }, "error_code": { "type": "string", "minLength": 1 } }, "required": [ "property_id", "depth_id", "quantile_id", "error_code" ] } } }, "required": [ "provider", "source_version", "resolution_meters", "pixel_selection", "disclaimer", "properties", "failures" ] }, { "type": "null" } ] }, "errorCode": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "errorDetail": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "r2Prefix": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "analysisId", "status", "signature" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/soil/pretaterra/analyze": { "post": { "operationId": "soil.pretaterra.analyze", "summary": "soil pretaterra analyze", "description": "Endpoint POST /soil/pretaterra/analyze. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1, "maxLength": 128 }, "geometry": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "Polygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } }, "required": [ "type", "coordinates" ] }, { "type": "object", "properties": { "type": { "const": "MultiPolygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } } }, "required": [ "type", "coordinates" ] } ] } }, "required": [ "userId", "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/soil/pretaterra/getAnalysis": { "post": { "operationId": "soil.pretaterra.getAnalysis", "summary": "soil pretaterra get Analysis", "description": "Endpoint POST /soil/pretaterra/getAnalysis. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1, "maxLength": 128 }, "analysisId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "userId", "analysisId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/biomes/pretaterra/resolve": { "post": { "operationId": "biomes.pretaterra.resolve", "summary": "biomes pretaterra resolve", "description": "Endpoint POST /biomes/pretaterra/resolve. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "geometry": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "Polygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } }, "required": [ "type", "coordinates" ] }, { "type": "object", "properties": { "type": { "const": "MultiPolygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } } }, "required": [ "type", "coordinates" ] } ] } }, "required": [ "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/sicar/lookup": { "post": { "operationId": "sicar.lookup", "summary": "sicar lookup", "description": "Endpoint POST /sicar/lookup. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "codImovel": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "codImovel" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/sicar/search": { "post": { "operationId": "sicar.search", "summary": "sicar search", "description": "Endpoint POST /sicar/search. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "stateSymbol": { "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "type": "string" }, "query": { "type": "string", "minLength": 2, "maxLength": 120 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/sicar/layers": { "post": { "operationId": "sicar.layers", "summary": "sicar layers", "description": "Endpoint POST /sicar/layers. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "stateSymbol": { "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "type": "string" } }, "required": [ "stateSymbol" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/sicar/mapLayer": { "post": { "operationId": "sicar.mapLayer", "summary": "sicar map Layer", "description": "Endpoint POST /sicar/mapLayer. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "stateSymbol": { "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "type": "string" }, "layer": { "enum": [ "property_boundary", "app", "legal_reserve", "native_vegetation", "consolidated_area", "restricted_use", "administrative_servitude", "hydrography", "spring", "watercourse", "fallow_area" ], "type": "string" } }, "required": [ "stateSymbol", "layer" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/mapBiomas/listSources": { "post": { "operationId": "mapBiomas.listSources", "summary": "map Biomas list Sources", "description": "Endpoint POST /mapBiomas/listSources. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/mapBiomas/analyzeLandCover": { "post": { "operationId": "mapBiomas.analyzeLandCover", "summary": "map Biomas analyze Land Cover", "description": "Endpoint POST /mapBiomas/analyzeLandCover. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "enum": [ "BRA", "PRY", "ARG", "PER" ], "type": "string" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "geometry": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "Polygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } }, "required": [ "type", "coordinates" ] }, { "type": "object", "properties": { "type": { "const": "MultiPolygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } } }, "required": [ "type", "coordinates" ] } ] } }, "required": [ "countryCode", "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/mapBiomas/pretaterra/analyzeLandCover": { "post": { "operationId": "mapBiomas.pretaterra.analyzeLandCover", "summary": "map Biomas pretaterra analyze Land Cover", "description": "Endpoint POST /mapBiomas/pretaterra/analyzeLandCover. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "enum": [ "BRA", "PRY", "ARG", "PER" ], "type": "string" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "geometry": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "Polygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } }, "required": [ "type", "coordinates" ] }, { "type": "object", "properties": { "type": { "const": "MultiPolygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } } }, "required": [ "type", "coordinates" ] } ] } }, "required": [ "countryCode", "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/mapBiomas/getRasterPath": { "post": { "operationId": "mapBiomas.getRasterPath", "summary": "map Biomas get Raster Path", "description": "Endpoint POST /mapBiomas/getRasterPath. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "countryCode": { "enum": [ "BRA", "PRY", "ARG", "PER" ], "type": "string" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "countryCode", "year" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/landCover/pretaterra/analyze": { "post": { "operationId": "landCover.pretaterra.analyze", "summary": "land Cover pretaterra analyze", "description": "Endpoint POST /landCover/pretaterra/analyze. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "geometry": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "Polygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } }, "required": [ "type", "coordinates" ] }, { "type": "object", "properties": { "type": { "const": "MultiPolygon" }, "coordinates": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 4, "items": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } } } } }, "required": [ "type", "coordinates" ] } ] }, "countryCode": { "enum": [ "BRA", "PRY", "ARG", "PER" ], "type": "string" }, "year": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "provider": { "enum": [ "auto", "mapbiomas", "esri", "both" ], "type": "string", "default": "auto" } }, "required": [ "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/landCover/sources": { "post": { "operationId": "landCover.sources", "summary": "land Cover sources", "description": "Endpoint POST /landCover/sources. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/articles/list": { "post": { "operationId": "partner.articles.list", "summary": "partner articles list", "description": "Endpoint POST /partner/articles/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "language": { "type": "string" }, "status": { "enum": [ "published", "draft", "all" ], "type": "string" }, "limit": { "type": "number", "default": 24 }, "page": { "type": "number", "default": 1 }, "category": { "type": "string" }, "author": { "type": "string" } }, "required": [ "status" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/articles/create": { "post": { "operationId": "partner.articles.create", "summary": "partner articles create", "description": "Endpoint POST /partner/articles/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "title": { "type": "string" }, "slug": { "type": "string" }, "content": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "language": { "type": "string" }, "views": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "alternatives": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "old_slugs": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string" }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "show": { "type": "boolean" } }, "required": [ "id", "title", "slug", "content" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/articles/update": { "post": { "operationId": "partner.articles.update", "summary": "partner articles update", "description": "Endpoint POST /partner/articles/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "title": { "type": "string" }, "slug": { "type": "string" }, "content": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "language": { "type": "string" }, "views": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "alternatives": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "old_slugs": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "type": { "type": "string" }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "show": { "type": "boolean" } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/articles/delete": { "post": { "operationId": "partner.articles.delete", "summary": "partner articles delete", "description": "Endpoint POST /partner/articles/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/articles/uploadImageUrl": { "post": { "operationId": "partner.articles.uploadImageUrl", "summary": "partner articles upload Image Url", "description": "Endpoint POST /partner/articles/uploadImageUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "articleSlug": { "type": "string" } }, "required": [ "articleSlug" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/list": { "post": { "operationId": "partner.contacts.list", "summary": "partner contacts list", "description": "Endpoint POST /partner/contacts/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "selection_scope": { "enum": [ "assigned", "company" ], "type": "string", "default": "assigned" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 24 }, "order": { "type": "string" }, "pipeline_type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "role": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "attendance_status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "temperature": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "responsible": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "insight": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-deal": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "property-region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region-radius": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "water": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "topography": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "production": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "infrastructure": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "documentation": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "accept-exchange": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "has-polygon": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/activeDeals": { "post": { "operationId": "partner.contacts.activeDeals", "summary": "partner contacts active Deals", "description": "Endpoint POST /partner/contacts/activeDeals. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "q": { "type": "string", "default": "" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 50 }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "role": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "attendance_status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "temperature": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "responsible": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "insight": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-deal": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "property-region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region-radius": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "water": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "topography": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "production": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "infrastructure": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "documentation": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "accept-exchange": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "has-polygon": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listBoard": { "post": { "operationId": "partner.contacts.listBoard", "summary": "partner contacts list Board", "description": "Endpoint POST /partner/contacts/listBoard. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 24 }, "order": { "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "role": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "attendance_status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "temperature": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "responsible": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "insight": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-deal": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "property-region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region-radius": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "water": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "topography": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "production": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "infrastructure": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "documentation": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "accept-exchange": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "has-polygon": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listBoardPipeline": { "post": { "operationId": "partner.contacts.listBoardPipeline", "summary": "partner contacts list Board Pipeline", "description": "Endpoint POST /partner/contacts/listBoardPipeline. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 24 }, "order": { "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "pipeline_type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "role": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "attendance_status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "temperature": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "responsible": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "insight": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-deal": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "property-region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region-radius": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "water": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "topography": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "production": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "infrastructure": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "documentation": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "accept-exchange": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "has-polygon": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "pipeline_type" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listCalendar": { "post": { "operationId": "partner.contacts.listCalendar", "summary": "partner contacts list Calendar", "description": "Endpoint POST /partner/contacts/listCalendar. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "range": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "x-native-type": "date" }, "end": { "type": "string", "format": "date-time", "x-native-type": "date" } }, "required": [ "start", "end" ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "role": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "attendance_status": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "temperature": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "responsible": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "insight": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-deal": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "listing-type": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "property-region": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "region-radius": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "min-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "max-price-per-area": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "water": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "topography": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "production": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "infrastructure": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "documentation": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "accept-exchange": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "has-polygon": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "range" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/find": { "post": { "operationId": "partner.contacts.find", "summary": "partner contacts find", "description": "Endpoint POST /partner/contacts/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "selection_scope": { "enum": [ "assigned", "company" ], "type": "string", "default": "assigned" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listHistory": { "post": { "operationId": "partner.contacts.listHistory", "summary": "partner contacts list History", "description": "Endpoint POST /partner/contacts/listHistory. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 6 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listActivities": { "post": { "operationId": "partner.contacts.listActivities", "summary": "partner contacts list Activities", "description": "Endpoint POST /partner/contacts/listActivities. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "limit": { "type": "number", "default": 50 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/createActivity": { "post": { "operationId": "partner.contacts.createActivity", "summary": "partner contacts create Activity", "description": "Endpoint POST /partner/contacts/createActivity. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "data": { "type": "object", "properties": { "activity_type": { "enum": [ "call", "meeting", "visit", "document_request", "note" ], "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "occurred_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "details": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "activity_type" ] } }, "required": [ "contactId", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/updateActivity": { "post": { "operationId": "partner.contacts.updateActivity", "summary": "partner contacts update Activity", "description": "Endpoint POST /partner/contacts/updateActivity. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "activityId": { "type": "string" }, "data": { "type": "object", "properties": { "activity_type": { "enum": [ "call", "meeting", "visit", "document_request", "note" ], "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "occurred_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "details": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] } } } }, "required": [ "contactId", "activityId", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/deleteActivity": { "post": { "operationId": "partner.contacts.deleteActivity", "summary": "partner contacts delete Activity", "description": "Endpoint POST /partner/contacts/deleteActivity. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "activityId": { "type": "string" } }, "required": [ "contactId", "activityId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listTimeline": { "post": { "operationId": "partner.contacts.listTimeline", "summary": "partner contacts list Timeline", "description": "Endpoint POST /partner/contacts/listTimeline. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listCampaigns": { "post": { "operationId": "partner.contacts.listCampaigns", "summary": "partner contacts list Campaigns", "description": "Endpoint POST /partner/contacts/listCampaigns. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listVisitsByContact": { "post": { "operationId": "partner.contacts.listVisitsByContact", "summary": "partner contacts list Visits By Contact", "description": "Endpoint POST /partner/contacts/listVisitsByContact. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listProposalsByContact": { "post": { "operationId": "partner.contacts.listProposalsByContact", "summary": "partner contacts list Proposals By Contact", "description": "Endpoint POST /partner/contacts/listProposalsByContact. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listFlows": { "post": { "operationId": "partner.contacts.listFlows", "summary": "partner contacts list Flows", "description": "Endpoint POST /partner/contacts/listFlows. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listPipelines": { "post": { "operationId": "partner.contacts.listPipelines", "summary": "partner contacts list Pipelines", "description": "Endpoint POST /partner/contacts/listPipelines. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/updatePipelineStage": { "post": { "operationId": "partner.contacts.updatePipelineStage", "summary": "partner contacts update Pipeline Stage", "description": "Endpoint POST /partner/contacts/updatePipelineStage. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "stageKey": { "type": "string" } }, "required": [ "contactId", "type", "stageKey" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/deletePipeline": { "post": { "operationId": "partner.contacts.deletePipeline", "summary": "partner contacts delete Pipeline", "description": "Endpoint POST /partner/contacts/deletePipeline. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" } }, "required": [ "contactId", "type" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/findByPhone": { "post": { "operationId": "partner.contacts.findByPhone", "summary": "partner contacts find By Phone", "description": "Endpoint POST /partner/contacts/findByPhone. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string" } }, "required": [ "phone" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/findByJid": { "post": { "operationId": "partner.contacts.findByJid", "summary": "partner contacts find By Jid", "description": "Endpoint POST /partner/contacts/findByJid. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "jid": { "type": "string" } }, "required": [ "jid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/findByPhones": { "post": { "operationId": "partner.contacts.findByPhones", "summary": "partner contacts find By Phones", "description": "Endpoint POST /partner/contacts/findByPhones. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phones": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "number", "default": 100 }, "page": { "type": "number", "default": 1 } }, "required": [ "phones" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/findByJids": { "post": { "operationId": "partner.contacts.findByJids", "summary": "partner contacts find By Jids", "description": "Endpoint POST /partner/contacts/findByJids. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "jids": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "number", "default": 100 }, "page": { "type": "number", "default": 1 }, "partner_id": { "type": "string" } }, "required": [ "jids" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/search": { "post": { "operationId": "partner.contacts.search", "summary": "partner contacts search", "description": "Endpoint POST /partner/contacts/search. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "q": { "type": "string", "minLength": 1 } }, "required": [ "q" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/create": { "post": { "operationId": "partner.contacts.create", "summary": "partner contacts create", "description": "Endpoint POST /partner/contacts/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "anyOf": [ { "not": {} }, { "type": "null" } ] }, "role": { "enum": [ "admin", "user", "partner" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram_handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_role": { "anyOf": [ { "enum": [ "admin", "assessor" ], "type": "string" }, { "type": "null" } ] }, "can_be_responsible": { "type": "boolean" }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser": { "type": "boolean" }, "advertiser_homepage": { "type": "boolean" }, "advertiser_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_portal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_integration_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_synced_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "terms_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cpf": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "automated_response": { "type": "boolean" }, "attendance_status": { "enum": [ "new", "no_reply", "follow_up", "automation", "paused", "ignore" ], "type": "string" }, "flow_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message_to_send": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "whatsapp_lid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "whatsapp_jid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_intermediary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purchase_power": { "anyOf": [ { "type": "number", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "contacted_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "follow_up_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "last_login_ip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_country_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_region_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_region_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_latitude": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "last_login_longitude": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "last_login_asn": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "last_login_org": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "old_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lead_score": { "type": "number", "minimum": -8388608, "maximum": 8388607 } }, "default": {} } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/update": { "post": { "operationId": "partner.contacts.update", "summary": "partner contacts update", "description": "Endpoint POST /partner/contacts/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "anyOf": [ { "not": {} }, { "type": "null" } ] }, "role": { "enum": [ "admin", "user", "partner" ], "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram_handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_role": { "anyOf": [ { "enum": [ "admin", "assessor" ], "type": "string" }, { "type": "null" } ] }, "can_be_responsible": { "type": "boolean" }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser": { "type": "boolean" }, "advertiser_homepage": { "type": "boolean" }, "advertiser_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_portal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_integration_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_synced_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "terms_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cpf": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "automated_response": { "type": "boolean" }, "attendance_status": { "enum": [ "new", "no_reply", "follow_up", "automation", "paused", "ignore" ], "type": "string" }, "flow_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message_to_send": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "whatsapp_lid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "whatsapp_jid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_intermediary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purchase_power": { "anyOf": [ { "type": "number", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "contacted_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "follow_up_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "last_login_ip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_country_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_region_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_region_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_login_latitude": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "last_login_longitude": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "last_login_asn": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "last_login_org": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "old_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lead_score": { "type": "number", "minimum": -8388608, "maximum": 8388607 }, "pipeline_stage_key": { "anyOf": [ { "enum": [ "new", "nurture", "qualification", "diagnosis", "area_search", "area_curation", "analysis", "visit", "negotiation", "purchased_with_us", "already_purchased_elsewhere", "failed_to_contact", "disqualified", "search_paused" ], "type": "string" }, { "type": "null" } ] } } }, "from": { "type": "string" } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/listListingChats": { "post": { "operationId": "partner.contacts.listListingChats", "summary": "partner contacts list Listing Chats", "description": "Endpoint POST /partner/contacts/listListingChats. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/recalculateLeadScore": { "post": { "operationId": "partner.contacts.recalculateLeadScore", "summary": "partner contacts recalculate Lead Score", "description": "Endpoint POST /partner/contacts/recalculateLeadScore. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/syncAvatarFromWhatsApp": { "post": { "operationId": "partner.contacts.syncAvatarFromWhatsApp", "summary": "partner contacts sync Avatar From Whats App", "description": "Endpoint POST /partner/contacts/syncAvatarFromWhatsApp. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "avatarUrl": { "type": "string", "format": "uri" } }, "required": [ "contactId", "avatarUrl" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/generateDescription": { "post": { "operationId": "partner.contacts.generateDescription", "summary": "partner contacts generate Description", "description": "Endpoint POST /partner/contacts/generateDescription. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "minLength": 1 }, "force": { "type": "boolean", "default": false } }, "required": [ "contactId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/generateAIReply": { "post": { "operationId": "partner.contacts.generateAIReply", "summary": "partner contacts generate AIReply", "description": "Endpoint POST /partner/contacts/generateAIReply. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "lastMessages": { "type": "array", "items": { "type": "object", "properties": { "role": { "enum": [ "user", "assistant" ], "type": "string" }, "content": { "type": "string" } }, "required": [ "role", "content" ] } } }, "required": [ "contactId", "lastMessages" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/getUploadPictureUrl": { "post": { "operationId": "partner.contacts.getUploadPictureUrl", "summary": "partner contacts get Upload Picture Url", "description": "Endpoint POST /partner/contacts/getUploadPictureUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/retriggerAI": { "post": { "operationId": "partner.contacts.retriggerAI", "summary": "partner contacts retrigger AI", "description": "Endpoint POST /partner/contacts/retriggerAI. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" } }, "required": [ "contactId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/delete": { "post": { "operationId": "partner.contacts.delete", "summary": "partner contacts delete", "description": "Endpoint POST /partner/contacts/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/charts/createdByMonth": { "post": { "operationId": "partner.contacts.charts.createdByMonth", "summary": "partner contacts charts created By Month", "description": "Endpoint POST /partner/contacts/charts/createdByMonth. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "months": { "type": "number", "default": 12 }, "partner_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/contacts/charts/createdByDay": { "post": { "operationId": "partner.contacts.charts.createdByDay", "summary": "partner contacts charts created By Day", "description": "Endpoint POST /partner/contacts/charts/createdByDay. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "days": { "type": "number", "default": 30 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/list": { "post": { "operationId": "partner.listings.list", "summary": "partner listings list", "description": "Endpoint POST /partner/listings/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "user_id": { "type": "string" }, "portfolio": { "type": "boolean" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "boolean" } ] } }, "required": [ "id" ] }, "default": [] }, "filterType": { "enum": [ "and", "or" ], "type": "string", "default": "and" }, "orderBy": { "type": "string", "default": "newest" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 24 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/searchPicker": { "post": { "operationId": "partner.listings.searchPicker", "summary": "partner listings search Picker", "description": "Endpoint POST /partner/listings/searchPicker. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "boolean" } ] } }, "required": [ "id" ] }, "default": [] }, "filterType": { "enum": [ "and", "or" ], "type": "string", "default": "and" }, "orderBy": { "type": "string", "default": "most-deals" }, "limit": { "type": "number", "default": 20 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/find": { "post": { "operationId": "partner.listings.find", "summary": "partner listings find", "description": "Endpoint POST /partner/listings/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "company_id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/listFavorites": { "post": { "operationId": "partner.listings.listFavorites", "summary": "partner listings list Favorites", "description": "Endpoint POST /partner/listings/listFavorites. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 5 }, "company_id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/listAiChats": { "post": { "operationId": "partner.listings.listAiChats", "summary": "partner listings list Ai Chats", "description": "Endpoint POST /partner/listings/listAiChats. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 5 }, "company_id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/update": { "post": { "operationId": "partner.listings.update", "summary": "partner listings update", "description": "Endpoint POST /partner/listings/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "broker_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "car": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "property_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_translations": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_source_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_generated_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "type": { "anyOf": [ { "enum": [ "country-home", "small-farm", "farm", "stud-farm", "plot", "cottage", "city-house", "apartment", "commercial", "lodging", "development", "island", "eco-village", "mining" ], "type": "string" }, { "type": "null" } ] }, "area": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency_unit_source": { "type": "string" }, "negotiation_min_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "accepted_payment_methods": { "type": "array", "items": { "enum": [ "cash", "financing", "bitcoin", "usd", "soy_bags", "gemstone", "exchange", "other" ], "type": "string" } }, "accepted_payment_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rental_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "for_exchange": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "exchange_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commission": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "country_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "state_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "city_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "district": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "neighborhood": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "coordinates": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lat": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "string" } }, "video": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "documents": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "polygon_geojson": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, { "type": "null" } ] }, "status": { "enum": [ "draft", "pending", "published", "off_market", "paused", "rejected", "duplicated", "approved", "suspicious", "removed", "integrated", "sold" ], "type": "string" }, "for_sale": { "type": "boolean" }, "for_rent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "for_auction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "image_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_relationship_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "property_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "priority_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "details": { "anyOf": [ { "type": "object", "properties": { "building_area": { "type": "number", "exclusiveMinimum": 0 }, "exchange": { "type": "boolean" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } }, "development": { "type": "object", "properties": { "category": { "enum": [ "gated_lot_community", "masterplan", "vertical_residential", "condohotel", "mixed_use" ], "type": "string" }, "total_area_m2": { "type": "number", "exclusiveMinimum": 0 }, "total_units": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "neighborhoods_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "amenities": { "type": "array", "items": { "enum": [ "controlled_access", "security_24h", "clubhouse", "crystal_lagoon", "white_sand_beach", "marina", "sports_courts", "gym", "pool", "playground", "walking_trails", "hotel_services" ], "type": "string" }, "default": [] }, "offerings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "enum": [ "plot", "studio", "apartment", "penthouse", "other" ], "type": "string" }, "area_from_m2": { "type": "number", "exclusiveMinimum": 0 }, "price_from": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 } }, "required": [ "name", "kind" ] }, "default": [] } }, "required": [ "category" ] } } }, { "type": "null" } ] }, "verified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_relationship": { "anyOf": [ { "enum": [ "owner", "relative", "direct_broker", "partner_broker" ], "type": "string" }, { "type": "null" } ] }, "reason_not_approved": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_rejection_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_audit_log": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "language_source": { "type": "string" }, "description_verified": { "type": "boolean" }, "old_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "images_migration_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cultivable_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "reserved_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "exposure": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "views": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "favorites_count": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "posted": { "type": "boolean" }, "satellite_video": { "type": "boolean" }, "marketing_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ad_origin": { "anyOf": [ { "enum": [ "advertise_site_forms", "whatsapp", "integration" ], "type": "string" }, { "type": "null" } ] }, "plan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "listing_pipeline_stage_key": { "anyOf": [ { "enum": [ "prospecting", "material_collection", "evaluation", "script", "video", "dispatch", "paid_traffic", "concluded" ], "type": "string" }, { "type": "null" } ] }, "draft_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "plan_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "embedding": { "anyOf": [ { "type": "array", "minItems": 1536, "maxItems": 1536, "items": { "type": "number" } }, { "type": "null" } ] }, "description": { "type": "string" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/delete": { "post": { "operationId": "partner.listings.delete", "summary": "partner listings delete", "description": "Endpoint POST /partner/listings/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/create": { "post": { "operationId": "partner.listings.create", "summary": "partner listings create", "description": "Endpoint POST /partner/listings/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "broker_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "car": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "property_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_translations": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_source_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_summary_generated_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "type": { "anyOf": [ { "enum": [ "country-home", "small-farm", "farm", "stud-farm", "plot", "cottage", "city-house", "apartment", "commercial", "lodging", "development", "island", "eco-village", "mining" ], "type": "string" }, { "type": "null" } ] }, "area": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency_unit_source": { "type": "string" }, "negotiation_min_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "accepted_payment_methods": { "type": "array", "items": { "enum": [ "cash", "financing", "bitcoin", "usd", "soy_bags", "gemstone", "exchange", "other" ], "type": "string" } }, "accepted_payment_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rental_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "for_exchange": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "exchange_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "commission": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "country_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "state_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "city_id": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "district": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "neighborhood": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "coordinates": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lat": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "string" } }, "video": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "documents": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "polygon_geojson": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, { "type": "null" } ] }, "status": { "enum": [ "draft", "pending", "published", "off_market", "paused", "rejected", "duplicated", "approved", "suspicious", "removed", "integrated", "sold" ], "type": "string" }, "for_sale": { "type": "boolean" }, "for_rent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "for_auction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "image_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_relationship_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "advertiser_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "property_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "priority_score": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "details": { "anyOf": [ { "type": "object", "properties": { "building_area": { "type": "number", "exclusiveMinimum": 0 }, "exchange": { "type": "boolean" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } }, "development": { "type": "object", "properties": { "category": { "enum": [ "gated_lot_community", "masterplan", "vertical_residential", "condohotel", "mixed_use" ], "type": "string" }, "total_area_m2": { "type": "number", "exclusiveMinimum": 0 }, "total_units": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "neighborhoods_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "amenities": { "type": "array", "items": { "enum": [ "controlled_access", "security_24h", "clubhouse", "crystal_lagoon", "white_sand_beach", "marina", "sports_courts", "gym", "pool", "playground", "walking_trails", "hotel_services" ], "type": "string" }, "default": [] }, "offerings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "enum": [ "plot", "studio", "apartment", "penthouse", "other" ], "type": "string" }, "area_from_m2": { "type": "number", "exclusiveMinimum": 0 }, "price_from": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 } }, "required": [ "name", "kind" ] }, "default": [] } }, "required": [ "category" ] } } }, { "type": "null" } ] }, "verified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advertiser_relationship": { "anyOf": [ { "enum": [ "owner", "relative", "direct_broker", "partner_broker" ], "type": "string" }, { "type": "null" } ] }, "reason_not_approved": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_rejection_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ai_audit_log": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "language_source": { "type": "string" }, "description_verified": { "type": "boolean" }, "old_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "images_migration_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cultivable_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "reserved_area": { "anyOf": [ { "type": "number", "minimum": -8388608, "maximum": 8388607 }, { "type": "null" } ] }, "exposure": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "views": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "favorites_count": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "posted": { "type": "boolean" }, "satellite_video": { "type": "boolean" }, "marketing_images": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ad_origin": { "anyOf": [ { "enum": [ "advertise_site_forms", "whatsapp", "integration" ], "type": "string" }, { "type": "null" } ] }, "plan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "listing_pipeline_stage_key": { "anyOf": [ { "enum": [ "prospecting", "material_collection", "evaluation", "script", "video", "dispatch", "paid_traffic", "concluded" ], "type": "string" }, { "type": "null" } ] }, "draft_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "plan_followup_sent_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "embedding": { "anyOf": [ { "type": "array", "minItems": 1536, "maxItems": 1536, "items": { "type": "number" } }, { "type": "null" } ] }, "description": { "type": "string" }, "pricing_features": { "type": "object", "properties": { "water": { "type": "array", "items": { "enum": [ "river", "spring", "lake", "reservoir", "stream", "well" ], "type": "string" } }, "topography": { "enum": [ "flat", "gently_rolling", "rolling", "steep_rolling", "mountainous" ], "type": "string" }, "production": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "main_use": { "type": "array", "items": { "enum": [ "agriculture", "grains", "coffee", "sugarcane", "fruit", "horticulture", "livestock", "beef_cattle", "dairy_cattle", "equine", "small_ruminants", "poultry", "fish_farming", "forest", "eucalyptus", "reforestation", "leisure", "agroforestry", "organic_production", "agroindustry", "carbon_conservation", "rural_tourism", "mixed" ], "type": "string" } }, "infrastructure": { "type": "array", "items": { "enum": [ "main_house", "condominium", "worker_house", "power", "three_phase_power", "internet", "barn", "corral", "silos" ], "type": "string" } } } } }, "required": [ "area" ], "default": { "area": 0 } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/charts/createdByDay": { "post": { "operationId": "partner.listings.charts.createdByDay", "summary": "partner listings charts created By Day", "description": "Endpoint POST /partner/listings/charts/createdByDay. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "days": { "type": "number", "default": 30 }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/charts/createdByMonth": { "post": { "operationId": "partner.listings.charts.createdByMonth", "summary": "partner listings charts created By Month", "description": "Endpoint POST /partner/listings/charts/createdByMonth. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "months": { "type": "number", "default": 12 }, "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/charts/exposureByDay": { "post": { "operationId": "partner.listings.charts.exposureByDay", "summary": "partner listings charts exposure By Day", "description": "Endpoint POST /partner/listings/charts/exposureByDay. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "days": { "type": "number", "default": 30 }, "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "source": { "enum": [ "properties_search", "homepage", "listing_group", "property_detail", "unknown" ], "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/generateVideo": { "post": { "operationId": "partner.listings.generateVideo", "summary": "partner listings generate Video", "description": "Endpoint POST /partner/listings/generateVideo. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/videoProgress": { "post": { "operationId": "partner.listings.videoProgress", "summary": "partner listings video Progress", "description": "Endpoint POST /partner/listings/videoProgress. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/listings/listHistory": { "post": { "operationId": "partner.listings.listHistory", "summary": "partner listings list History", "description": "Endpoint POST /partner/listings/listHistory. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "company_id": { "type": "string" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 5 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/deals/list": { "post": { "operationId": "partner.deals.list", "summary": "partner deals list", "description": "Endpoint POST /partner/deals/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "state": { "type": "string" }, "buyer": { "type": "string" }, "listing": { "type": "string" }, "responsible": { "type": "string" }, "company_id": { "type": "string" }, "origin": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 50 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/deals/listByProperty": { "post": { "operationId": "partner.deals.listByProperty", "summary": "partner deals list By Property", "description": "Endpoint POST /partner/deals/listByProperty. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 20, "default": 5 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/deals/find": { "post": { "operationId": "partner.deals.find", "summary": "partner deals find", "description": "Endpoint POST /partner/deals/find. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/deals/report": { "post": { "operationId": "partner.deals.report", "summary": "partner deals report", "description": "Endpoint POST /partner/deals/report. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "state": { "type": "string" }, "buyer": { "type": "string" }, "listing": { "type": "string" }, "responsible": { "type": "string" }, "company_id": { "type": "string" }, "origin": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 50 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/deals/create": { "post": { "operationId": "partner.deals.create", "summary": "partner deals create", "description": "Endpoint POST /partner/deals/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listing_id": { "type": "string" }, "buyer_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "listing_id", "buyer_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/deals/update": { "post": { "operationId": "partner.deals.update", "summary": "partner deals update", "description": "Endpoint POST /partner/deals/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "listing_id": { "type": "string" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authored_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/deals/delete": { "post": { "operationId": "partner.deals.delete", "summary": "partner deals delete", "description": "Endpoint POST /partner/deals/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/proposals/listByDeal": { "post": { "operationId": "partner.proposals.listByDeal", "summary": "partner proposals list By Deal", "description": "Endpoint POST /partner/proposals/listByDeal. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dealId": { "type": "string" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 20, "default": 5 } }, "required": [ "dealId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/proposals/listByListing": { "post": { "operationId": "partner.proposals.listByListing", "summary": "partner proposals list By Listing", "description": "Endpoint POST /partner/proposals/listByListing. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 20, "default": 5 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/proposals/update": { "post": { "operationId": "partner.proposals.update", "summary": "partner proposals update", "description": "Endpoint POST /partner/proposals/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "authored_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "type": "number", "minimum": -140737488355328, "maximum": 140737488355327 }, "currency": { "type": "string" }, "payment_method": { "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/proposals/delete": { "post": { "operationId": "partner.proposals.delete", "summary": "partner proposals delete", "description": "Endpoint POST /partner/proposals/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/proposals/create": { "post": { "operationId": "partner.proposals.create", "summary": "partner proposals create", "description": "Endpoint POST /partner/proposals/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deal_id": { "type": "string" }, "value": { "type": "number" }, "currency": { "type": "string", "default": "BRL" }, "payment_method": { "type": "string", "default": "cash" }, "notes": { "type": "string" } }, "required": [ "deal_id", "value" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/services/listTable": { "post": { "operationId": "partner.services.listTable", "summary": "partner services list Table", "description": "Endpoint POST /partner/services/listTable. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 24 }, "order": { "type": "string" }, "region": { "type": "string" }, "responsible": { "type": "string" }, "valuation": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/services/listByContact": { "post": { "operationId": "partner.services.listByContact", "summary": "partner services list By Contact", "description": "Endpoint POST /partner/services/listByContact. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "company_id": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 24 } }, "required": [ "contactId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/services/update": { "post": { "operationId": "partner.services.update", "summary": "partner services update", "description": "Endpoint POST /partner/services/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "contacted_at": { "anyOf": [ { "type": "string", "format": "date-time", "x-native-type": "date" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "form": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "area": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "valuation_interest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priority": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purpose": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "broker_responsible_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/totalSales": { "post": { "operationId": "partner.metrics.totalSales", "summary": "partner metrics total Sales", "description": "Endpoint POST /partner/metrics/totalSales. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/totalSalesInMonth": { "post": { "operationId": "partner.metrics.totalSalesInMonth", "summary": "partner metrics total Sales In Month", "description": "Endpoint POST /partner/metrics/totalSalesInMonth. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/totalActiveLeads": { "post": { "operationId": "partner.metrics.totalActiveLeads", "summary": "partner metrics total Active Leads", "description": "Endpoint POST /partner/metrics/totalActiveLeads. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/totalProperties": { "post": { "operationId": "partner.metrics.totalProperties", "summary": "partner metrics total Properties", "description": "Endpoint POST /partner/metrics/totalProperties. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/totalPendingTasks": { "post": { "operationId": "partner.metrics.totalPendingTasks", "summary": "partner metrics total Pending Tasks", "description": "Endpoint POST /partner/metrics/totalPendingTasks. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/totalClosedDeals": { "post": { "operationId": "partner.metrics.totalClosedDeals", "summary": "partner metrics total Closed Deals", "description": "Endpoint POST /partner/metrics/totalClosedDeals. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/conversionRate": { "post": { "operationId": "partner.metrics.conversionRate", "summary": "partner metrics conversion Rate", "description": "Endpoint POST /partner/metrics/conversionRate. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/pipeline": { "post": { "operationId": "partner.metrics.pipeline", "summary": "partner metrics pipeline", "description": "Endpoint POST /partner/metrics/pipeline. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/dashboard": { "post": { "operationId": "partner.metrics.dashboard", "summary": "partner metrics dashboard", "description": "Endpoint POST /partner/metrics/dashboard. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "months": { "type": "number", "default": 12 }, "include_dev_metrics": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/insights": { "post": { "operationId": "partner.metrics.insights", "summary": "partner metrics insights", "description": "Endpoint POST /partner/metrics/insights. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/refreshInsights": { "post": { "operationId": "partner.metrics.refreshInsights", "summary": "partner metrics refresh Insights", "description": "Endpoint POST /partner/metrics/refreshInsights. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/listingsMetrics": { "post": { "operationId": "partner.metrics.listingsMetrics", "summary": "partner metrics listings Metrics", "description": "Endpoint POST /partner/metrics/listingsMetrics. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/dashboardHistory": { "post": { "operationId": "partner.metrics.dashboardHistory", "summary": "partner metrics dashboard History", "description": "Endpoint POST /partner/metrics/dashboardHistory. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "months": { "type": "number", "default": 12 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/commercialReport": { "post": { "operationId": "partner.metrics.commercialReport", "summary": "partner metrics commercial Report", "description": "Endpoint POST /partner/metrics/commercialReport. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "since": { "type": "string" }, "until": { "type": "string" }, "origin": { "type": "string" }, "campaign": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/metrics/getBuyerMetrics": { "post": { "operationId": "partner.metrics.getBuyerMetrics", "summary": "partner metrics get Buyer Metrics", "description": "Endpoint POST /partner/metrics/getBuyerMetrics. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/searches/list": { "post": { "operationId": "partner.searches.list", "summary": "partner searches list", "description": "Endpoint POST /partner/searches/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 50 }, "userId": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/searches/create": { "post": { "operationId": "partner.searches.create", "summary": "partner searches create", "description": "Endpoint POST /partner/searches/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "company_id": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purchase_power": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "id", "value" ] } } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/searches/update": { "post": { "operationId": "partner.searches.update", "summary": "partner searches update", "description": "Endpoint POST /partner/searches/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purchase_power": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "id", "value" ] } } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/searches/delete": { "post": { "operationId": "partner.searches.delete", "summary": "partner searches delete", "description": "Endpoint POST /partner/searches/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/visits/listCalendar": { "post": { "operationId": "partner.visits.listCalendar", "summary": "partner visits list Calendar", "description": "Endpoint POST /partner/visits/listCalendar. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_id": { "type": "string" }, "company_id": { "type": "string" }, "range": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "x-native-type": "date" }, "end": { "type": "string", "format": "date-time", "x-native-type": "date" } }, "required": [ "start", "end" ] } }, "required": [ "range" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/visits/listByProperty": { "post": { "operationId": "partner.visits.listByProperty", "summary": "partner visits list By Property", "description": "Endpoint POST /partner/visits/listByProperty. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 20, "default": 5 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/visits/update": { "post": { "operationId": "partner.visits.update", "summary": "partner visits update", "description": "Endpoint POST /partner/visits/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "deal_id": { "type": "string" }, "authored_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date": { "type": "string" }, "time": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ] }, "status": { "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "x-native-type": "date" }, "updated_at": { "type": "string", "format": "date-time", "x-native-type": "date" } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/visits/create": { "post": { "operationId": "partner.visits.create", "summary": "partner visits create", "description": "Endpoint POST /partner/visits/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "listingId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deal_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date": { "type": "string" }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "date" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/visits/delete": { "post": { "operationId": "partner.visits.delete", "summary": "partner visits delete", "description": "Endpoint POST /partner/visits/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/visits/listByDeal": { "post": { "operationId": "partner.visits.listByDeal", "summary": "partner visits list By Deal", "description": "Endpoint POST /partner/visits/listByDeal. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dealId": { "type": "string" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 20, "default": 5 } }, "required": [ "dealId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/quickReplies/list": { "post": { "operationId": "partner.quickReplies.list", "summary": "partner quick Replies list", "description": "Endpoint POST /partner/quickReplies/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tasks/list": { "post": { "operationId": "partner.tasks.list", "summary": "partner tasks list", "description": "Endpoint POST /partner/tasks/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 20 }, "status": { "enum": [ "open", "done", "all" ], "type": "string", "default": "open" }, "q": { "type": "string", "default": "" }, "listingId": { "type": "string" }, "sort": { "enum": [ "updated_at_desc", "updated_at_asc", "created_at_desc", "created_at_asc", "deadline_asc", "deadline_desc", "contact_name_asc", "contact_name_desc" ], "type": "string", "default": "updated_at_desc" }, "responsible": { "type": "string" }, "company_id": { "type": "string" }, "deadline": { "enum": [ "overdue", "none", "today", "week" ], "type": "string" }, "origin": { "type": "string" }, "temperature": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tasks/listByContact": { "post": { "operationId": "partner.tasks.listByContact", "summary": "partner tasks list By Contact", "description": "Endpoint POST /partner/tasks/listByContact. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" } }, "required": [ "contactId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tasks/create": { "post": { "operationId": "partner.tasks.create", "summary": "partner tasks create", "description": "Endpoint POST /partner/tasks/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "listingId": { "type": "string" }, "description": { "type": "string", "minLength": 2 }, "deadline": { "type": "string" }, "responsibleUserId": { "type": "string" } }, "required": [ "description" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tasks/update": { "post": { "operationId": "partner.tasks.update", "summary": "partner tasks update", "description": "Endpoint POST /partner/tasks/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string", "minLength": 2 }, "status": { "type": "string" }, "deadline": { "type": "string" }, "responsibleUserId": { "type": "string" } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tasks/delete": { "post": { "operationId": "partner.tasks.delete", "summary": "partner tasks delete", "description": "Endpoint POST /partner/tasks/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tickets/list": { "post": { "operationId": "partner.tickets.list", "summary": "partner tickets list", "description": "Endpoint POST /partner/tickets/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 20 }, "status": { "enum": [ "open", "done", "all" ], "type": "string", "default": "open" }, "q": { "type": "string", "default": "" }, "responsible": { "type": "string" }, "contactId": { "type": "string" }, "company_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tickets/listByContact": { "post": { "operationId": "partner.tickets.listByContact", "summary": "partner tickets list By Contact", "description": "Endpoint POST /partner/tickets/listByContact. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" } }, "required": [ "contactId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tickets/create": { "post": { "operationId": "partner.tickets.create", "summary": "partner tickets create", "description": "Endpoint POST /partner/tickets/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "description": { "type": "string", "minLength": 2 }, "responsibleUserId": { "type": "string" } }, "required": [ "description" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tickets/update": { "post": { "operationId": "partner.tickets.update", "summary": "partner tickets update", "description": "Endpoint POST /partner/tickets/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string", "minLength": 2 }, "status": { "enum": [ "open", "done" ], "type": "string" }, "responsibleUserId": { "type": "string" } } } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/tickets/delete": { "post": { "operationId": "partner.tickets.delete", "summary": "partner tickets delete", "description": "Endpoint POST /partner/tickets/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/whatsapp/resolveJid": { "post": { "operationId": "partner.whatsapp.resolveJid", "summary": "partner whatsapp resolve Jid", "description": "Endpoint POST /partner/whatsapp/resolveJid. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "phone": { "type": "string" }, "deviceId": { "type": "string" } }, "required": [ "id", "phone" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/whatsapp/groups": { "post": { "operationId": "partner.whatsapp.groups", "summary": "partner whatsapp groups", "description": "Endpoint POST /partner/whatsapp/groups. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/push/subscribe": { "post": { "operationId": "partner.push.subscribe", "summary": "partner push subscribe", "description": "Endpoint POST /partner/push/subscribe. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "endpoint": { "type": "string" }, "expirationTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keys": { "type": "object", "properties": { "p256dh": { "type": "string" }, "auth": { "type": "string" } }, "required": [ "p256dh", "auth" ] } }, "required": [ "endpoint", "keys" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/push/unsubscribe": { "post": { "operationId": "partner.push.unsubscribe", "summary": "partner push unsubscribe", "description": "Endpoint POST /partner/push/unsubscribe. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/push/vapidKey": { "post": { "operationId": "partner.push.vapidKey", "summary": "partner push vapid Key", "description": "Endpoint POST /partner/push/vapidKey. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/device": { "post": { "operationId": "partner.conversations.device", "summary": "partner conversations device", "description": "Endpoint POST /partner/conversations/device. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/list": { "post": { "operationId": "partner.conversations.list", "summary": "partner conversations list", "description": "Endpoint POST /partner/conversations/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 }, "cursor": { "type": "string" }, "showArchived": { "type": "boolean", "default": false }, "includeSnippets": { "type": "boolean", "default": true }, "includeContactCounts": { "type": "boolean", "default": true }, "search": { "type": "string" }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" }, "pipeline": { "enum": [ "all", "buyer", "advertiser", "service", "partner" ], "type": "string", "default": "all" }, "attendanceStatus": { "enum": [ "new", "no_reply", "follow_up", "automation", "paused", "ignore" ], "type": "string" }, "scope": { "enum": [ "all", "direct", "group" ], "type": "string", "default": "all" }, "order": { "type": "string", "default": "newest" }, "partnerId": { "type": "string" }, "companyId": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/snippet": { "post": { "operationId": "partner.conversations.snippet", "summary": "partner conversations snippet", "description": "Endpoint POST /partner/conversations/snippet. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "companyId": { "type": "string" }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/snippets": { "post": { "operationId": "partner.conversations.snippets", "summary": "partner conversations snippets", "description": "Endpoint POST /partner/conversations/snippets. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJids": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "minLength": 1 } }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJids" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/thread": { "post": { "operationId": "partner.conversations.thread", "summary": "partner conversations thread", "description": "Endpoint POST /partner/conversations/thread. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "companyId": { "type": "string" }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/messages": { "post": { "operationId": "partner.conversations.messages", "summary": "partner conversations messages", "description": "Endpoint POST /partner/conversations/messages. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 }, "cursor": { "type": "string" }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/messageHistory": { "post": { "operationId": "partner.conversations.messageHistory", "summary": "partner conversations message History", "description": "Endpoint POST /partner/conversations/messageHistory. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "messageId": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "messageId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/avatar": { "post": { "operationId": "partner.conversations.avatar", "summary": "partner conversations avatar", "description": "Endpoint POST /partner/conversations/avatar. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "phone": { "type": "string", "minLength": 1 }, "isPreview": { "type": "boolean" }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "phone" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/downloadMedia": { "post": { "operationId": "partner.conversations.downloadMedia", "summary": "partner conversations download Media", "description": "Endpoint POST /partner/conversations/downloadMedia. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "messageId": { "type": "string", "minLength": 1 }, "phone": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "messageId", "phone" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/repairMedia": { "post": { "operationId": "partner.conversations.repairMedia", "summary": "partner conversations repair Media", "description": "Endpoint POST /partner/conversations/repairMedia. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "messageId": { "type": "string", "minLength": 1 } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/sendMessage": { "post": { "operationId": "partner.conversations.sendMessage", "summary": "partner conversations send Message", "description": "Endpoint POST /partner/conversations/sendMessage. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "text": { "type": "string", "minLength": 1 }, "replyMessageId": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "text" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/updateMessage": { "post": { "operationId": "partner.conversations.updateMessage", "summary": "partner conversations update Message", "description": "Endpoint POST /partner/conversations/updateMessage. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "messageId": { "type": "string", "minLength": 1 }, "text": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "messageId", "text" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/deleteMessage": { "post": { "operationId": "partner.conversations.deleteMessage", "summary": "partner conversations delete Message", "description": "Endpoint POST /partner/conversations/deleteMessage. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "messageId": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "messageId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/sendContact": { "post": { "operationId": "partner.conversations.sendContact", "summary": "partner conversations send Contact", "description": "Endpoint POST /partner/conversations/sendContact. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "contactId": { "type": "string", "minLength": 1 }, "contactName": { "type": "string", "minLength": 1 }, "contactPhone": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/sendLink": { "post": { "operationId": "partner.conversations.sendLink", "summary": "partner conversations send Link", "description": "Endpoint POST /partner/conversations/sendLink. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "link": { "type": "string", "minLength": 1 }, "caption": { "type": "string" }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "link" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/handoff": { "post": { "operationId": "partner.conversations.handoff", "summary": "partner conversations handoff", "description": "Endpoint POST /partner/conversations/handoff. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "contactId": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "contactId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/sendListingInfo": { "post": { "operationId": "partner.conversations.sendListingInfo", "summary": "partner conversations send Listing Info", "description": "Endpoint POST /partner/conversations/sendListingInfo. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "dealId": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "dealId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/sendMedia": { "post": { "operationId": "partner.conversations.sendMedia", "summary": "partner conversations send Media", "description": "Endpoint POST /partner/conversations/sendMedia. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "fileName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "base64": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "base64" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/approveDraft": { "post": { "operationId": "partner.conversations.approveDraft", "summary": "partner conversations approve Draft", "description": "Endpoint POST /partner/conversations/approveDraft. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "text": { "type": "string", "minLength": 1 }, "contactId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid", "text" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/rejectDraft": { "post": { "operationId": "partner.conversations.rejectDraft", "summary": "partner conversations reject Draft", "description": "Endpoint POST /partner/conversations/rejectDraft. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "contactId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/resolveJid": { "post": { "operationId": "partner.conversations.resolveJid", "summary": "partner conversations resolve Jid", "description": "Endpoint POST /partner/conversations/resolveJid. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "phone": { "type": "string", "minLength": 1 }, "deviceId": { "type": "string" }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "id", "phone" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/markRead": { "post": { "operationId": "partner.conversations.markRead", "summary": "partner conversations mark Read", "description": "Endpoint POST /partner/conversations/markRead. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/markUnread": { "post": { "operationId": "partner.conversations.markUnread", "summary": "partner conversations mark Unread", "description": "Endpoint POST /partner/conversations/markUnread. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/archive": { "post": { "operationId": "partner.conversations.archive", "summary": "partner conversations archive", "description": "Endpoint POST /partner/conversations/archive. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/unarchive": { "post": { "operationId": "partner.conversations.unarchive", "summary": "partner conversations unarchive", "description": "Endpoint POST /partner/conversations/unarchive. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/partner/conversations/updateAttendanceStatus": { "post": { "operationId": "partner.conversations.updateAttendanceStatus", "summary": "partner conversations update Attendance Status", "description": "Endpoint POST /partner/conversations/updateAttendanceStatus. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "chatJid": { "type": "string", "minLength": 1 }, "attendanceStatus": { "enum": [ "new", "no_reply", "follow_up", "automation", "paused", "ignore" ], "type": "string" }, "sourceMode": { "enum": [ "reland", "gowa" ], "type": "string", "default": "reland" } }, "required": [ "chatJid" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/geoBoundaries/list": { "post": { "operationId": "admin.geoBoundaries.list", "summary": "admin geo Boundaries list", "description": "Endpoint POST /admin/geoBoundaries/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "parent_id": { "type": "string", "minLength": 1 }, "country_iso3": { "type": "string", "minLength": 3, "maxLength": 3 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/aiWhatsappSandbox/run": { "post": { "operationId": "admin.aiWhatsappSandbox.run", "summary": "admin ai Whatsapp Sandbox run", "description": "Endpoint POST /admin/aiWhatsappSandbox/run. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "minItems": 1, "maxItems": 30, "items": { "type": "object", "properties": { "role": { "enum": [ "user", "assistant" ], "type": "string" }, "content": { "type": "string", "minLength": 1 } }, "required": [ "role", "content" ] } }, "mode": { "enum": [ "qualifier", "property_presenter", "hybrid" ], "type": "string" }, "model": { "enum": [ "current", "gpt_5_6_luna", "gpt_5_6_terra" ], "type": "string" }, "conversation_state": { "enum": [ "active", "awaiting_contact_preference", "handed_off" ], "type": "string" }, "conversation_summary": { "anyOf": [ { "type": "string", "maxLength": 1200 }, { "type": "null" } ] }, "contact_id": { "type": "string", "minLength": 1 }, "language": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" } }, "required": [ "messages" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "lead_kind": { "enum": [ "buyer", "property_owner", "platform_question", "unclear" ], "type": "string" }, "reply_text": { "type": "string" }, "needs_human": { "type": "boolean" }, "human_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "conversation_state": { "enum": [ "active", "awaiting_contact_preference", "handed_off" ], "type": "string" }, "context_action": { "enum": [ "continue", "reset" ], "type": "string" }, "conversation_summary": { "anyOf": [ { "type": "string", "maxLength": 1200 }, { "type": "null" } ] }, "tool_calls": { "type": "array", "maxItems": 3, "items": { "anyOf": [ { "type": "object", "properties": { "name": { "const": "search_listings" }, "input": { "type": "object", "properties": { "query": { "type": "string", "minLength": 3, "maxLength": 500 }, "limit": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3 } }, "required": [ "query" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "get_listing_details" }, "input": { "type": "object", "properties": { "listing_id": { "type": "string", "minLength": 1 }, "listing_code": { "type": "string", "minLength": 1 } } } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "search_knowledge" }, "input": { "type": "object", "properties": { "query": { "type": "string", "minLength": 3, "maxLength": 500 }, "limit": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3 } }, "required": [ "query" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "create_visit_request" }, "input": { "type": "object", "properties": { "listing_id": { "type": "string", "minLength": 1 }, "preferred_date": { "type": "string", "maxLength": 100 }, "notes": { "type": "string", "maxLength": 500 } }, "required": [ "listing_id" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "handoff_to_agent" }, "input": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 3, "maxLength": 500 } }, "required": [ "reason" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "compare_listings" }, "input": { "type": "object", "properties": { "listing_ids": { "type": "array", "minItems": 2, "maxItems": 3, "items": { "type": "string", "minLength": 1 } } }, "required": [ "listing_ids" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "get_listing_availability" }, "input": { "type": "object", "properties": { "listing_id": { "type": "string", "minLength": 1 } }, "required": [ "listing_id" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "save_search_preferences" }, "input": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 200 }, "region": { "type": "string", "maxLength": 150 }, "min_area_ha": { "type": "number", "exclusiveMinimum": 0 }, "max_area_ha": { "type": "number", "exclusiveMinimum": 0 }, "min_price": { "type": "number", "exclusiveMinimum": 0 }, "max_price": { "type": "number", "exclusiveMinimum": 0 }, "intended_use": { "type": "string", "maxLength": 250 } } } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "create_listing_interest" }, "input": { "type": "object", "properties": { "listing_id": { "type": "string", "minLength": 1 }, "notes": { "type": "string", "maxLength": 500 } }, "required": [ "listing_id" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "get_contact_next_step" }, "input": { "type": "object" } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "search_regions" }, "input": { "type": "object", "properties": { "query": { "type": "string", "minLength": 2, "maxLength": 150 } }, "required": [ "query" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "get_purchase_guidance" }, "input": { "type": "object", "properties": { "query": { "type": "string", "minLength": 3, "maxLength": 500 } }, "required": [ "query" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "create_callback_request" }, "input": { "type": "object", "properties": { "preferred_period": { "enum": [ "morning", "afternoon", "evening" ], "type": "string" }, "notes": { "type": "string", "maxLength": 500 } } } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "get_financing_options" }, "input": { "type": "object", "properties": { "query": { "type": "string", "minLength": 3, "maxLength": 500 } }, "required": [ "query" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "report_listing_issue" }, "input": { "type": "object", "properties": { "listing_id": { "type": "string", "minLength": 1 }, "issue": { "type": "string", "minLength": 3, "maxLength": 500 } }, "required": [ "listing_id", "issue" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "create_service_request" }, "input": { "type": "object", "properties": { "service_type": { "enum": [ "property_valuation", "property_report", "market_analysis", "document_review", "other" ], "type": "string" }, "listing_id": { "type": "string", "minLength": 1 }, "notes": { "type": "string", "minLength": 3, "maxLength": 500 } }, "required": [ "service_type", "notes" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "recommend_similar_listings" }, "input": { "type": "object", "properties": { "listing_id": { "type": "string", "minLength": 1 } }, "required": [ "listing_id" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "subscribe_to_search_alerts" }, "input": { "type": "object", "properties": { "title": { "type": "string", "minLength": 3, "maxLength": 200 }, "query": { "type": "string", "minLength": 3, "maxLength": 500 } }, "required": [ "title", "query" ] } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "summarize_for_agent" }, "input": { "type": "object" } }, "required": [ "name", "input" ] }, { "type": "object", "properties": { "name": { "const": "update_crm" }, "input": { "type": "object", "properties": { "contact": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 320, "format": "email" }, "type": { "enum": [ "buyer", "property_owner" ], "type": "string" }, "objective": { "type": "string", "maxLength": 500 }, "region": { "type": "string", "maxLength": 150 }, "state": { "type": "string", "maxLength": 50 }, "notes": { "type": "string", "maxLength": 1000 }, "description": { "type": "string", "maxLength": 1000 }, "temperature": { "enum": [ "cold", "warm", "hot", "very-hot" ], "type": "string" }, "purchase_power": { "type": "number", "exclusiveMinimum": 0 } } }, "pipeline": { "type": "object", "properties": { "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "stage_key": { "type": "string", "minLength": 1, "maxLength": 100 }, "reason": { "type": "string", "minLength": 3, "maxLength": 500 } }, "required": [ "type", "stage_key", "reason" ] } } } }, "required": [ "name", "input" ] } ] } }, "tool_trace": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "input": { "type": "string" }, "status": { "enum": [ "requested", "completed", "failed" ], "type": "string" }, "result": { "type": "string", "maxLength": 2000 }, "error": { "type": "string", "maxLength": 500 } }, "required": [ "name", "input", "status" ] } }, "crm_delta": { "type": "object", "properties": { "contact": { "type": "object", "properties": { "language": { "enum": [ "pt-br", "en", "es", "zh", "ar", "hi", "ru", "fr", "de", "ja" ], "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "type": { "enum": [ "buyer", "property_owner" ], "type": "string" }, "objective": { "type": "string" }, "region": { "type": "string" }, "state": { "type": "string" }, "notes": { "type": "string" }, "description": { "type": "string" }, "temperature": { "enum": [ "cold", "warm", "hot", "very-hot" ], "type": "string" } } }, "search": { "anyOf": [ { "type": "object", "properties": { "title": { "type": "string" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purchase_power": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "id", "value" ] } } }, "required": [ "title", "region", "urgency", "notes", "purchase_power", "filters" ] }, { "type": "null" } ] } }, "required": [ "contact", "search" ] }, "applied": { "const": false }, "initial_menu": { "anyOf": [ { "type": "object", "properties": { "body": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ] } } }, "required": [ "body", "options" ] }, { "type": "null" } ] } }, "required": [ "lead_kind", "reply_text", "needs_human", "human_reason", "conversation_state", "context_action", "conversation_summary", "tool_calls", "tool_trace", "crm_delta", "applied", "initial_menu" ] } } } } } } }, "/admin/sdrChats/list": { "post": { "operationId": "admin.sdrChats.list", "summary": "admin sdr Chats list", "description": "Endpoint POST /admin/sdrChats/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 }, "query": { "type": "string", "maxLength": 200 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sdrChats/thread": { "post": { "operationId": "admin.sdrChats.thread", "summary": "admin sdr Chats thread", "description": "Endpoint POST /admin/sdrChats/thread. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneNumberId": { "type": "string", "minLength": 1 }, "waId": { "type": "string", "minLength": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } }, "required": [ "phoneNumberId", "waId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sdrChats/audit": { "post": { "operationId": "admin.sdrChats.audit", "summary": "admin sdr Chats audit", "description": "Endpoint POST /admin/sdrChats/audit. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneNumberId": { "type": "string", "minLength": 1 }, "waId": { "type": "string", "minLength": 1 } }, "required": [ "phoneNumberId", "waId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/listingImageAnalysis/suggest": { "post": { "operationId": "admin.listingImageAnalysis.suggest", "summary": "admin listing Image Analysis suggest", "description": "Endpoint POST /admin/listingImageAnalysis/suggest. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string", "minLength": 1 }, "model": { "enum": [ "gemini-2.5-flash-lite", "gemini-3.1-flash-lite" ], "type": "string", "default": "gemini-2.5-flash-lite" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/getSystemSettings": { "post": { "operationId": "admin.getSystemSettings", "summary": "admin get System Settings", "description": "Endpoint POST /admin/getSystemSettings. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/advertisers/list": { "post": { "operationId": "admin.advertisers.list", "summary": "admin advertisers list", "description": "Endpoint POST /admin/advertisers/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "partner_pipeline_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/advertiserLeads/list": { "post": { "operationId": "admin.advertiserLeads.list", "summary": "admin advertiser Leads list", "description": "Endpoint POST /admin/advertiserLeads/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/listingChats/list": { "post": { "operationId": "admin.listingChats.list", "summary": "admin listing Chats list", "description": "Endpoint POST /admin/listingChats/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/metaAds/list": { "post": { "operationId": "admin.metaAds.list", "summary": "admin meta Ads list", "description": "Endpoint POST /admin/metaAds/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/metaAds/videoPreview": { "post": { "operationId": "admin.metaAds.videoPreview", "summary": "admin meta Ads video Preview", "description": "Endpoint POST /admin/metaAds/videoPreview. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "videoId": { "type": "string", "minLength": 1 } }, "required": [ "videoId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/metaLeadForms/list": { "post": { "operationId": "admin.metaLeadForms.list", "summary": "admin meta Lead Forms list", "description": "Endpoint POST /admin/metaLeadForms/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/metaLeadForms/detail": { "post": { "operationId": "admin.metaLeadForms.detail", "summary": "admin meta Lead Forms detail", "description": "Endpoint POST /admin/metaLeadForms/detail. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "formId": { "type": "string", "minLength": 1 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0, "default": 1 }, "campaignId": { "type": "string", "minLength": 1 }, "adsetId": { "type": "string", "minLength": 1 }, "adId": { "type": "string", "minLength": 1 }, "answerKey": { "type": "string", "minLength": 1 }, "answerValue": { "type": "string", "minLength": 1 }, "assessorId": { "type": "string", "minLength": 1 }, "temperature": { "enum": [ "cold", "warm", "hot", "very-hot", "no-temperature" ], "type": "string" }, "search": { "type": "string", "minLength": 1 }, "submittedFrom": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "submittedTo": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "receivedVia": { "enum": [ "webhook", "sync" ], "type": "string" }, "handoffStatus": { "enum": [ "awaiting_confirmation", "engaged", "declined_pending_reason", "declined", "transferring", "transferred", "expired", "failed", "no-handoff" ], "type": "string" }, "pipelineStage": { "type": "string", "minLength": 1 }, "sort": { "enum": [ "newest", "oldest", "contact_name_asc", "contact_name_desc", "campaign_name_asc", "campaign_name_desc", "adset_name_asc", "adset_name_desc", "ad_name_asc", "ad_name_desc", "assessor_name_asc", "assessor_name_desc", "temperature_desc", "temperature_asc" ], "type": "string", "default": "newest" } }, "required": [ "formId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leads/list": { "post": { "operationId": "admin.leads.list", "summary": "admin leads list", "description": "Endpoint POST /admin/leads/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 500, "default": 50 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 }, "order": { "enum": [ "newest", "oldest", "name_asc", "name_desc" ], "type": "string", "default": "newest" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/listResponsibles": { "post": { "operationId": "admin.listResponsibles", "summary": "admin list Responsibles", "description": "Endpoint POST /admin/listResponsibles. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 2000, "default": 2000 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/buyerFunnelDashboard": { "post": { "operationId": "admin.buyerFunnelDashboard", "summary": "admin buyer Funnel Dashboard", "description": "Endpoint POST /admin/buyerFunnelDashboard. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "until": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/searchDashboard": { "post": { "operationId": "admin.searchDashboard", "summary": "admin search Dashboard", "description": "Endpoint POST /admin/searchDashboard. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "since": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "until": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/updateSystemSettings": { "post": { "operationId": "admin.updateSystemSettings", "summary": "admin update System Settings", "description": "Endpoint POST /admin/updateSystemSettings. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "whatsapp_ai_enabled": { "type": "boolean" }, "followups_enabled": { "type": "boolean" }, "trigger_or_campaign_only": { "type": "boolean" }, "whatsapp_ai_base_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram_dm_auto_reply_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowed_contacts": { "type": "array", "items": { "type": "string" } }, "handoff_fallback_contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/getSuspiciousListings": { "post": { "operationId": "admin.getSuspiciousListings", "summary": "admin get Suspicious Listings", "description": "Endpoint POST /admin/getSuspiciousListings. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "status": { "type": "string" }, "limit": { "type": "number", "default": 50 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/getAuditProposal": { "post": { "operationId": "admin.getAuditProposal", "summary": "admin get Audit Proposal", "description": "Endpoint POST /admin/getAuditProposal. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/applyAudit": { "post": { "operationId": "admin.applyAudit", "summary": "admin apply Audit", "description": "Endpoint POST /admin/applyAudit. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "proposal": { "not": {} }, "action": { "enum": [ "approve", "reject" ], "type": "string", "default": "approve" } }, "required": [ "proposal" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/createListingFromText": { "post": { "operationId": "admin.createListingFromText", "summary": "admin create Listing From Text", "description": "Endpoint POST /admin/createListingFromText. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "minLength": 20 } }, "required": [ "text" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/getContactsByIds": { "post": { "operationId": "admin.getContactsByIds", "summary": "admin get Contacts By Ids", "description": "Endpoint POST /admin/getContactsByIds. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/quickReplies/list": { "post": { "operationId": "admin.quickReplies.list", "summary": "admin quick Replies list", "description": "Endpoint POST /admin/quickReplies/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/quickReplies/create": { "post": { "operationId": "admin.quickReplies.create", "summary": "admin quick Replies create", "description": "Endpoint POST /admin/quickReplies/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "content": { "type": "string", "minLength": 1 } }, "required": [ "title", "content" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/quickReplies/update": { "post": { "operationId": "admin.quickReplies.update", "summary": "admin quick Replies update", "description": "Endpoint POST /admin/quickReplies/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string", "minLength": 1 }, "content": { "type": "string", "minLength": 1 } }, "required": [ "id", "title", "content" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/quickReplies/delete": { "post": { "operationId": "admin.quickReplies.delete", "summary": "admin quick Replies delete", "description": "Endpoint POST /admin/quickReplies/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/followups/list": { "post": { "operationId": "admin.followups.list", "summary": "admin followups list", "description": "Endpoint POST /admin/followups/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/followups/save": { "post": { "operationId": "admin.followups.save", "summary": "admin followups save", "description": "Endpoint POST /admin/followups/save. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sequence_key": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "trigger_stage": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "steps": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "delay_ms": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "enum": [ "text", "audio-text" ], "type": "string", "default": "text" }, "message_template": { "type": "string", "minLength": 1 }, "audio_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "temperature": { "enum": [ "hot", "warm", "cold" ], "type": "string", "default": "cold" }, "enabled": { "type": "boolean" } }, "required": [ "delay_ms", "message_template" ] } } }, "required": [ "sequence_key", "name", "trigger_stage", "steps" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/followups/delete": { "post": { "operationId": "admin.followups.delete", "summary": "admin followups delete", "description": "Endpoint POST /admin/followups/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/followups/recalculatePending": { "post": { "operationId": "admin.followups.recalculatePending", "summary": "admin followups recalculate Pending", "description": "Endpoint POST /admin/followups/recalculatePending. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leadFlows/list": { "post": { "operationId": "admin.leadFlows.list", "summary": "admin lead Flows list", "description": "Endpoint POST /admin/leadFlows/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leadFlows/report": { "post": { "operationId": "admin.leadFlows.report", "summary": "admin lead Flows report", "description": "Endpoint POST /admin/leadFlows/report. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leadFlows/instagramCommentLeadLinkShortUrl": { "post": { "operationId": "admin.leadFlows.instagramCommentLeadLinkShortUrl", "summary": "admin lead Flows instagram Comment Lead Link Short Url", "description": "Endpoint POST /admin/leadFlows/instagramCommentLeadLinkShortUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leadFlows/syncMetaAds": { "post": { "operationId": "admin.leadFlows.syncMetaAds", "summary": "admin lead Flows sync Meta Ads", "description": "Endpoint POST /admin/leadFlows/syncMetaAds. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leadFlows/syncInstagramPosts": { "post": { "operationId": "admin.leadFlows.syncInstagramPosts", "summary": "admin lead Flows sync Instagram Posts", "description": "Endpoint POST /admin/leadFlows/syncInstagramPosts. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leadFlows/create": { "post": { "operationId": "admin.leadFlows.create", "summary": "admin lead Flows create", "description": "Endpoint POST /admin/leadFlows/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" }, "campaign_kind": { "enum": [ "buyer", "property_owner", "franchise", "service" ], "type": "string" }, "channel": { "enum": [ "meta_ads", "google_ads", "whatsapp", "instagram", "other" ], "type": "string" }, "listing_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_ctwa_clid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "handoff_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_pipeline_stage_key": { "anyOf": [ { "enum": [ "new", "nurture", "qualification", "diagnosis", "area_search", "area_curation", "analysis", "visit", "negotiation", "purchased_with_us", "already_purchased_elsewhere", "failed_to_contact", "disqualified", "search_paused" ], "type": "string" }, { "type": "null" } ] }, "default_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_automated_response": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "name", "campaign_kind", "channel" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leadFlows/update": { "post": { "operationId": "admin.leadFlows.update", "summary": "admin lead Flows update", "description": "Endpoint POST /admin/leadFlows/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" }, "campaign_kind": { "enum": [ "buyer", "property_owner", "franchise", "service" ], "type": "string" }, "channel": { "enum": [ "meta_ads", "google_ads", "whatsapp", "instagram", "other" ], "type": "string" }, "listing_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_ctwa_clid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "handoff_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_pipeline_stage_key": { "anyOf": [ { "enum": [ "new", "nurture", "qualification", "diagnosis", "area_search", "area_curation", "analysis", "visit", "negotiation", "purchased_with_us", "already_purchased_elsewhere", "failed_to_contact", "disqualified", "search_paused" ], "type": "string" }, { "type": "null" } ] }, "default_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_automated_response": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "id": { "type": "string" } }, "required": [ "name", "campaign_kind", "channel", "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/leadFlows/delete": { "post": { "operationId": "admin.leadFlows.delete", "summary": "admin lead Flows delete", "description": "Endpoint POST /admin/leadFlows/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/campaigns/list": { "post": { "operationId": "admin.campaigns.list", "summary": "admin campaigns list", "description": "Endpoint POST /admin/campaigns/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/campaigns/report": { "post": { "operationId": "admin.campaigns.report", "summary": "admin campaigns report", "description": "Endpoint POST /admin/campaigns/report. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/campaigns/instagramCommentLeadLinkShortUrl": { "post": { "operationId": "admin.campaigns.instagramCommentLeadLinkShortUrl", "summary": "admin campaigns instagram Comment Lead Link Short Url", "description": "Endpoint POST /admin/campaigns/instagramCommentLeadLinkShortUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/campaigns/syncMetaAds": { "post": { "operationId": "admin.campaigns.syncMetaAds", "summary": "admin campaigns sync Meta Ads", "description": "Endpoint POST /admin/campaigns/syncMetaAds. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/campaigns/syncInstagramPosts": { "post": { "operationId": "admin.campaigns.syncInstagramPosts", "summary": "admin campaigns sync Instagram Posts", "description": "Endpoint POST /admin/campaigns/syncInstagramPosts. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/campaigns/create": { "post": { "operationId": "admin.campaigns.create", "summary": "admin campaigns create", "description": "Endpoint POST /admin/campaigns/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" }, "campaign_kind": { "enum": [ "buyer", "property_owner", "franchise", "service" ], "type": "string" }, "channel": { "enum": [ "meta_ads", "google_ads", "whatsapp", "instagram", "other" ], "type": "string" }, "listing_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_ctwa_clid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "handoff_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_pipeline_stage_key": { "anyOf": [ { "enum": [ "new", "nurture", "qualification", "diagnosis", "area_search", "area_curation", "analysis", "visit", "negotiation", "purchased_with_us", "already_purchased_elsewhere", "failed_to_contact", "disqualified", "search_paused" ], "type": "string" }, { "type": "null" } ] }, "default_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_automated_response": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "name", "campaign_kind", "channel" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/campaigns/update": { "post": { "operationId": "admin.campaigns.update", "summary": "admin campaigns update", "description": "Endpoint POST /admin/campaigns/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" }, "campaign_kind": { "enum": [ "buyer", "property_owner", "franchise", "service" ], "type": "string" }, "channel": { "enum": [ "meta_ads", "google_ads", "whatsapp", "instagram", "other" ], "type": "string" }, "listing_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_ctwa_clid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "handoff_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_pipeline_stage_key": { "anyOf": [ { "enum": [ "new", "nurture", "qualification", "diagnosis", "area_search", "area_curation", "analysis", "visit", "negotiation", "purchased_with_us", "already_purchased_elsewhere", "failed_to_contact", "disqualified", "search_paused" ], "type": "string" }, { "type": "null" } ] }, "default_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_automated_response": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "id": { "type": "string" } }, "required": [ "name", "campaign_kind", "channel", "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/campaigns/delete": { "post": { "operationId": "admin.campaigns.delete", "summary": "admin campaigns delete", "description": "Endpoint POST /admin/campaigns/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/list": { "post": { "operationId": "admin.pipelines.list", "summary": "admin pipelines list", "description": "Endpoint POST /admin/pipelines/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/workspace": { "post": { "operationId": "admin.pipelines.workspace", "summary": "admin pipelines workspace", "description": "Endpoint POST /admin/pipelines/workspace. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/saveMetadata": { "post": { "operationId": "admin.pipelines.saveMetadata", "summary": "admin pipelines save Metadata", "description": "Endpoint POST /admin/pipelines/saveMetadata. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "name": { "type": "string", "minLength": 1 }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "is_default": { "type": "boolean" } }, "required": [ "type", "name" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/saveStage": { "post": { "operationId": "admin.pipelines.saveStage", "summary": "admin pipelines save Stage", "description": "Endpoint POST /admin/pipelines/saveStage. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "key": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "position": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1 }, "is_closed": { "type": "boolean" }, "is_lost": { "type": "boolean" } }, "required": [ "type", "key", "label", "position", "color" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/deleteStage": { "post": { "operationId": "admin.pipelines.deleteStage", "summary": "admin pipelines delete Stage", "description": "Endpoint POST /admin/pipelines/deleteStage. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "stage_id": { "type": "string", "minLength": 1 } }, "required": [ "type", "stage_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/reorderStages": { "post": { "operationId": "admin.pipelines.reorderStages", "summary": "admin pipelines reorder Stages", "description": "Endpoint POST /admin/pipelines/reorderStages. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "stage_ids": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 } } }, "required": [ "type", "stage_ids" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/saveItem": { "post": { "operationId": "admin.pipelines.saveItem", "summary": "admin pipelines save Item", "description": "Endpoint POST /admin/pipelines/saveItem. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "buyer", "advertiser", "partner", "service" ], "type": "string" }, "subject_user_id": { "type": "string", "minLength": 1 }, "stage_id": { "type": "string", "minLength": 1 }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metadata": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type", "subject_user_id", "stage_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/moveItem": { "post": { "operationId": "admin.pipelines.moveItem", "summary": "admin pipelines move Item", "description": "Endpoint POST /admin/pipelines/moveItem. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "item_id": { "type": "string", "minLength": 1 }, "stage_id": { "type": "string", "minLength": 1 }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "stage_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/pipelines/archiveItem": { "post": { "operationId": "admin.pipelines.archiveItem", "summary": "admin pipelines archive Item", "description": "Endpoint POST /admin/pipelines/archiveItem. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "item_id": { "type": "string", "minLength": 1 }, "archived": { "type": "boolean" } }, "required": [ "item_id", "archived" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/whatsappReplyRepair/scan": { "post": { "operationId": "admin.whatsappReplyRepair.scan", "summary": "admin whatsapp Reply Repair scan", "description": "Endpoint POST /admin/whatsappReplyRepair/scan. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "since": { "type": "string", "minLength": 1, "default": "2026-03-22" }, "actionDelayMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 6000 }, "actionDelayJitterMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 2500 }, "caseDelayMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 15000 }, "caseDelayJitterMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 5000 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/whatsappReplyRepair/replay": { "post": { "operationId": "admin.whatsappReplyRepair.replay", "summary": "admin whatsapp Reply Repair replay", "description": "Endpoint POST /admin/whatsappReplyRepair/replay. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "since": { "type": "string", "minLength": 1, "default": "2026-03-22" }, "actionDelayMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 6000 }, "actionDelayJitterMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 2500 }, "caseDelayMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 15000 }, "caseDelayJitterMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 5000 }, "dryRun": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/whatsappMediaBackfill/run": { "post": { "operationId": "admin.whatsappMediaBackfill.run", "summary": "admin whatsapp Media Backfill run", "description": "Endpoint POST /admin/whatsappMediaBackfill/run. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apply": { "type": "boolean", "default": false }, "afterId": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 }, "beforeId": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ], "default": null }, "batchSize": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 200 }, "maxBatches": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, { "type": "null" } ], "default": null }, "deviceId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "default": null }, "chatJid": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "default": null }, "messageId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "default": null }, "onlyRecoverable": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/instagramCommentRepair/scan": { "post": { "operationId": "admin.instagramCommentRepair.scan", "summary": "admin instagram Comment Repair scan", "description": "Endpoint POST /admin/instagramCommentRepair/scan. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "since": { "type": "string", "minLength": 1, "default": "2026-04-29T00:00" }, "until": { "type": "string", "minLength": 1, "default": "2026-05-01T00:00" }, "dryRun": { "type": "boolean", "default": false }, "delayMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/instagramCommentRepair/replay": { "post": { "operationId": "admin.instagramCommentRepair.replay", "summary": "admin instagram Comment Repair replay", "description": "Endpoint POST /admin/instagramCommentRepair/replay. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "since": { "type": "string", "minLength": 1, "default": "2026-04-29T00:00" }, "until": { "type": "string", "minLength": 1, "default": "2026-05-01T00:00" }, "dryRun": { "type": "boolean", "default": false }, "delayMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "default": 0 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/instagramCommentAutomation/templates/list": { "post": { "operationId": "admin.instagramCommentAutomation.templates.list", "summary": "admin instagram Comment Automation templates list", "description": "Endpoint POST /admin/instagramCommentAutomation/templates/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/instagramCommentAutomation/templates/create": { "post": { "operationId": "admin.instagramCommentAutomation.templates.create", "summary": "admin instagram Comment Automation templates create", "description": "Endpoint POST /admin/instagramCommentAutomation/templates/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "content": { "type": "string", "minLength": 1 }, "is_active": { "type": "boolean", "default": true }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "default": 0 } }, "required": [ "title", "content" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/instagramCommentAutomation/templates/update": { "post": { "operationId": "admin.instagramCommentAutomation.templates.update", "summary": "admin instagram Comment Automation templates update", "description": "Endpoint POST /admin/instagramCommentAutomation/templates/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "content": { "type": "string", "minLength": 1 }, "is_active": { "type": "boolean", "default": true }, "sort_order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "default": 0 }, "id": { "type": "string", "minLength": 1 } }, "required": [ "title", "content", "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/instagramCommentAutomation/templates/delete": { "post": { "operationId": "admin.instagramCommentAutomation.templates.delete", "summary": "admin instagram Comment Automation templates delete", "description": "Endpoint POST /admin/instagramCommentAutomation/templates/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/instagramCommentAutomation/replay": { "post": { "operationId": "admin.instagramCommentAutomation.replay", "summary": "admin instagram Comment Automation replay", "description": "Endpoint POST /admin/instagramCommentAutomation/replay. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "commentId": { "type": "string", "minLength": 1 } }, "required": [ "commentId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/companies/list": { "post": { "operationId": "admin.companies.list", "summary": "admin companies list", "description": "Endpoint POST /admin/companies/list. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "q": { "type": "string", "default": "" }, "kind": { "enum": [ "all", "crm", "franchise", "other" ], "type": "string", "default": "all" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/companies/get": { "post": { "operationId": "admin.companies.get", "summary": "admin companies get", "description": "Endpoint POST /admin/companies/get. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "default": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/companies/create": { "post": { "operationId": "admin.companies.create", "summary": "admin companies create", "description": "Endpoint POST /admin/companies/create. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "enum": [ "crm", "franchise", "other" ], "type": "string" }, "picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "portal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "integration_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/companies/update": { "post": { "operationId": "admin.companies.update", "summary": "admin companies update", "description": "Endpoint POST /admin/companies/update. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "kind": { "enum": [ "crm", "franchise", "other" ], "type": "string" }, "picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "portal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "integration_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string", "minLength": 1 } }, "required": [ "name", "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/companies/delete": { "post": { "operationId": "admin.companies.delete", "summary": "admin companies delete", "description": "Endpoint POST /admin/companies/delete. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/companies/updateMemberRole": { "post": { "operationId": "admin.companies.updateMemberRole", "summary": "admin companies update Member Role", "description": "Endpoint POST /admin/companies/updateMemberRole. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "company_id": { "type": "string", "minLength": 1 }, "user_id": { "type": "string", "minLength": 1 }, "company_role": { "anyOf": [ { "enum": [ "admin", "assessor" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "company_id", "user_id", "company_role" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/companies/getUploadPictureUrl": { "post": { "operationId": "admin.companies.getUploadPictureUrl", "summary": "admin companies get Upload Picture Url", "description": "Endpoint POST /admin/companies/getUploadPictureUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/operations": { "post": { "operationId": "admin.sicar.operations", "summary": "admin sicar operations", "description": "Endpoint POST /admin/sicar/operations. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/control_worker": { "post": { "operationId": "admin.sicar.control_worker", "summary": "admin sicar control_worker", "description": "Endpoint POST /admin/sicar/control_worker. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "enum": [ "pause", "resume" ], "type": "string" } }, "required": [ "action" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/enqueue": { "post": { "operationId": "admin.sicar.enqueue", "summary": "admin sicar enqueue", "description": "Endpoint POST /admin/sicar/enqueue. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "states": { "type": "array", "minItems": 1, "items": { "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "type": "string" } }, "layers": { "type": "array", "minItems": 1, "items": { "enum": [ "CADASTRO_BASICO", "AREA_IMOVEL", "APPS", "VEGETACAO_NATIVA", "AREA_CONSOLIDADA", "AREA_POUSIO", "HIDROGRAFIA", "USO_RESTRITO", "SERVIDAO_ADMINISTRATIVA", "RESERVA_LEGAL" ], "type": "string" } }, "source_type": { "enum": [ "automatic", "manual" ], "type": "string", "default": "automatic" }, "priority": { "type": "integer", "minimum": -100, "maximum": 100, "default": 0 } }, "required": [ "states", "layers" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/control": { "post": { "operationId": "admin.sicar.control", "summary": "admin sicar control", "description": "Endpoint POST /admin/sicar/control. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "layer_ids": { "type": "array", "minItems": 1, "maxItems": 500, "items": { "type": "string", "minLength": 1 } }, "action": { "enum": [ "execute", "pause", "resume", "cancel", "retry" ], "type": "string" } }, "required": [ "layer_ids", "action" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/refresh_references": { "post": { "operationId": "admin.sicar.refresh_references", "summary": "admin sicar refresh_references", "description": "Endpoint POST /admin/sicar/refresh_references. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "states": { "type": "array", "minItems": 1, "items": { "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "type": "string" } } }, "required": [ "states" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/map_municipality": { "post": { "operationId": "admin.sicar.map_municipality", "summary": "admin sicar map_municipality", "description": "Endpoint POST /admin/sicar/map_municipality. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "boundary_id": { "type": "string", "minLength": 1 } }, "required": [ "boundary_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/identify_spatial": { "post": { "operationId": "admin.sicar.identify_spatial", "summary": "admin sicar identify_spatial", "description": "Endpoint POST /admin/sicar/identify_spatial. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "state_symbol": { "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "type": "string" }, "geometry": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "Point" }, "coordinates": { "type": "array", "prefixItems": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "number", "minimum": -90, "maximum": 90 } ] } }, "required": [ "type", "coordinates" ] }, { "type": "object", "properties": { "type": { "const": "Polygon" }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] } } } }, "required": [ "type", "coordinates" ] }, { "type": "object", "properties": { "type": { "const": "MultiPolygon" }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] } } } } }, "required": [ "type", "coordinates" ] } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, "required": [ "state_symbol", "geometry" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/start_manual_upload": { "post": { "operationId": "admin.sicar.start_manual_upload", "summary": "admin sicar start_manual_upload", "description": "Endpoint POST /admin/sicar/start_manual_upload. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "layer_id": { "type": "string", "minLength": 1 }, "file_size": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "layer_id", "file_size" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/manual_upload_part_url": { "post": { "operationId": "admin.sicar.manual_upload_part_url", "summary": "admin sicar manual_upload_part_url", "description": "Endpoint POST /admin/sicar/manual_upload_part_url. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "layer_id": { "type": "string", "minLength": 1 }, "part_number": { "type": "integer", "minimum": 1, "maximum": 10000 } }, "required": [ "layer_id", "part_number" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/record_manual_upload_part": { "post": { "operationId": "admin.sicar.record_manual_upload_part", "summary": "admin sicar record_manual_upload_part", "description": "Endpoint POST /admin/sicar/record_manual_upload_part. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "layer_id": { "type": "string", "minLength": 1 }, "part_number": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "size": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "layer_id", "part_number", "size" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/complete_manual_upload": { "post": { "operationId": "admin.sicar.complete_manual_upload", "summary": "admin sicar complete_manual_upload", "description": "Endpoint POST /admin/sicar/complete_manual_upload. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "layer_id": { "type": "string", "minLength": 1 } }, "required": [ "layer_id" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/manual_uploads": { "post": { "operationId": "admin.sicar.manual_uploads", "summary": "admin sicar manual_uploads", "description": "Endpoint POST /admin/sicar/manual_uploads. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/dashboard": { "post": { "operationId": "admin.sicar.dashboard", "summary": "admin sicar dashboard", "description": "Endpoint POST /admin/sicar/dashboard. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/search": { "post": { "operationId": "admin.sicar.search", "summary": "admin sicar search", "description": "Endpoint POST /admin/sicar/search. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "term": { "type": "string", "minLength": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } }, "required": [ "term" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/sicar/lookup": { "post": { "operationId": "admin.sicar.lookup", "summary": "admin sicar lookup", "description": "Endpoint POST /admin/sicar/lookup. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "codImovel": { "type": "string", "minLength": 1 } }, "required": [ "codImovel" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/listingPricingFeaturesBackfill/run": { "post": { "operationId": "admin.listingPricingFeaturesBackfill.run", "summary": "admin listing Pricing Features Backfill run", "description": "Endpoint POST /admin/listingPricingFeaturesBackfill/run. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apply": { "type": "boolean", "default": false }, "batchSize": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 500 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/documentsMigration/listPending": { "post": { "operationId": "admin.documentsMigration.listPending", "summary": "admin documents Migration list Pending", "description": "Endpoint POST /admin/documentsMigration/listPending. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "number", "default": 1 }, "limit": { "type": "number", "default": 50 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/documentsMigration/migrate": { "post": { "operationId": "admin.documentsMigration.migrate", "summary": "admin documents Migration migrate", "description": "Endpoint POST /admin/documentsMigration/migrate. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "fileName": { "type": "string" }, "type": { "enum": [ "presentation", "deed", "environmental_registry", "tax_id", "geospatial", "other" ], "type": "string" } }, "required": [ "listingId", "fileName", "type" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/documentsMigration/ignore": { "post": { "operationId": "admin.documentsMigration.ignore", "summary": "admin documents Migration ignore", "description": "Endpoint POST /admin/documentsMigration/ignore. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "fileName": { "type": "string" } }, "required": [ "listingId", "fileName" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/documentsMigration/renameLegacy": { "post": { "operationId": "admin.documentsMigration.renameLegacy", "summary": "admin documents Migration rename Legacy", "description": "Endpoint POST /admin/documentsMigration/renameLegacy. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" }, "oldFileName": { "type": "string" }, "newFileName": { "type": "string" } }, "required": [ "listingId", "oldFileName", "newFileName" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/documentsMigration/migrateExisting": { "post": { "operationId": "admin.documentsMigration.migrateExisting", "summary": "admin documents Migration migrate Existing", "description": "Endpoint POST /admin/documentsMigration/migrateExisting. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/documentsMigration/audit": { "post": { "operationId": "admin.documentsMigration.audit", "summary": "admin documents Migration audit", "description": "Endpoint POST /admin/documentsMigration/audit. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/documentsMigration/fixMisplaced": { "post": { "operationId": "admin.documentsMigration.fixMisplaced", "summary": "admin documents Migration fix Misplaced", "description": "Endpoint POST /admin/documentsMigration/fixMisplaced. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/bestBuys": { "post": { "operationId": "admin.bestBuys", "summary": "admin best Buys", "description": "Endpoint POST /admin/bestBuys. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "enum": [ "best_price", "premium" ], "type": "string" }, "types": { "type": "array", "items": { "enum": [ "country-home", "small-farm", "farm", "stud-farm", "plot", "cottage", "city-house", "apartment", "commercial", "lodging", "development", "island", "eco-village", "mining" ], "type": "string" } }, "price_min": { "type": "number" }, "price_max": { "type": "number" }, "area_min_ha": { "type": "number" }, "area_max_ha": { "type": "number" }, "state": { "type": "string" }, "limit": { "type": "number", "minimum": 1, "maximum": 50, "default": 20 } }, "required": [ "mode" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/impersonate": { "post": { "operationId": "admin.impersonate", "summary": "admin impersonate", "description": "Endpoint POST /admin/impersonate. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/migrateR2": { "post": { "operationId": "admin.migrateR2", "summary": "admin migrate R2", "description": "Endpoint POST /admin/migrateR2. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "number" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/normalizeR2Images": { "post": { "operationId": "admin.normalizeR2Images", "summary": "admin normalize R2 Images", "description": "Endpoint POST /admin/normalizeR2Images. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "number" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/retryFailedMigrations": { "post": { "operationId": "admin.retryFailedMigrations", "summary": "admin retry Failed Migrations", "description": "Endpoint POST /admin/retryFailedMigrations. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "number" }, "userId": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/updateListingEmbedding": { "post": { "operationId": "admin.updateListingEmbedding", "summary": "admin update Listing Embedding", "description": "Endpoint POST /admin/updateListingEmbedding. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "listingId": { "type": "string" } }, "required": [ "listingId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/updateManyListingsEmbeddings": { "post": { "operationId": "admin.updateManyListingsEmbeddings", "summary": "admin update Many Listings Embeddings", "description": "Endpoint POST /admin/updateManyListingsEmbeddings. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cityId": { "type": "number" }, "batchSize": { "type": "number", "default": 50 }, "maxBatches": { "type": "number", "default": 10 }, "force": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/recalculateLeadScores": { "post": { "operationId": "admin.recalculateLeadScores", "summary": "admin recalculate Lead Scores", "description": "Endpoint POST /admin/recalculateLeadScores. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "batchSize": { "type": "number", "default": 25 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/updateCurrencies": { "post": { "operationId": "admin.updateCurrencies", "summary": "admin update Currencies", "description": "Endpoint POST /admin/updateCurrencies. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/syncAgriculturalCommodities": { "post": { "operationId": "admin.syncAgriculturalCommodities", "summary": "admin sync Agricultural Commodities", "description": "Endpoint POST /admin/syncAgriculturalCommodities. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/getAgriculturalCommodities": { "post": { "operationId": "admin.getAgriculturalCommodities", "summary": "admin get Agricultural Commodities", "description": "Endpoint POST /admin/getAgriculturalCommodities. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/verifyListingImages": { "post": { "operationId": "admin.verifyListingImages", "summary": "admin verify Listing Images", "description": "Endpoint POST /admin/verifyListingImages. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "batchSize": { "type": "number", "default": 20 }, "maxBatches": { "type": "number", "default": 50 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/stopTasks": { "post": { "operationId": "admin.stopTasks", "summary": "admin stop Tasks", "description": "Endpoint POST /admin/stopTasks. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/migrateUserPictures": { "post": { "operationId": "admin.migrateUserPictures", "summary": "admin migrate User Pictures", "description": "Endpoint POST /admin/migrateUserPictures. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/syncWhatsAppContactAvatars": { "post": { "operationId": "admin.syncWhatsAppContactAvatars", "summary": "admin sync Whats App Contact Avatars", "description": "Endpoint POST /admin/syncWhatsAppContactAvatars. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/syncAdvertiser": { "post": { "operationId": "admin.syncAdvertiser", "summary": "admin sync Advertiser", "description": "Endpoint POST /admin/syncAdvertiser. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "advertiserId": { "type": "string" } }, "required": [ "advertiserId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/syncAllAdvertisers": { "post": { "operationId": "admin.syncAllAdvertisers", "summary": "admin sync All Advertisers", "description": "Endpoint POST /admin/syncAllAdvertisers. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/updateAdvertiserIntegration": { "post": { "operationId": "admin.updateAdvertiserIntegration", "summary": "admin update Advertiser Integration", "description": "Endpoint POST /admin/updateAdvertiserIntegration. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "advertiserId": { "type": "string" }, "advertiser_portal": { "type": "string" }, "advertiser_integration_link": { "type": "string" }, "advertiser_homepage": { "type": "boolean" }, "advertiser_quality_score": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 4 }, { "type": "null" } ] } }, "required": [ "advertiserId" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/previewAdvertiser": { "post": { "operationId": "admin.previewAdvertiser", "summary": "admin preview Advertiser", "description": "Endpoint POST /admin/previewAdvertiser. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/createAdvertiser": { "post": { "operationId": "admin.createAdvertiser", "summary": "admin create Advertiser", "description": "Endpoint POST /admin/createAdvertiser. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "advertiser_portal": { "type": "string" }, "advertiser_integration_link": { "type": "string" }, "advertiser_homepage": { "type": "boolean" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/auditPublishedListings": { "post": { "operationId": "admin.auditPublishedListings", "summary": "admin audit Published Listings", "description": "Endpoint POST /admin/auditPublishedListings. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/auditPendingListingsAI": { "post": { "operationId": "admin.auditPendingListingsAI", "summary": "admin audit Pending Listings AI", "description": "Endpoint POST /admin/auditPendingListingsAI. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/scrubAndFixDescriptions": { "post": { "operationId": "admin.scrubAndFixDescriptions", "summary": "admin scrub And Fix Descriptions", "description": "Endpoint POST /admin/scrubAndFixDescriptions. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "number" }, "userId": { "type": "string" }, "onlySuspicious": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/auditAllListingDescriptions": { "post": { "operationId": "admin.auditAllListingDescriptions", "summary": "admin audit All Listing Descriptions", "description": "Endpoint POST /admin/auditAllListingDescriptions. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "number", "exclusiveMinimum": 0 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/fetchXmlFromUrl": { "post": { "operationId": "admin.fetchXmlFromUrl", "summary": "admin fetch Xml From Url", "description": "Endpoint POST /admin/fetchXmlFromUrl. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/admin/formatXmlAsPortal": { "post": { "operationId": "admin.formatXmlAsPortal", "summary": "admin format Xml As Portal", "description": "Endpoint POST /admin/formatXmlAsPortal. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "xmlJson": { "type": "object", "additionalProperties": {} }, "portalName": { "type": "string" }, "limit": { "type": "number", "default": 10 } }, "required": [ "xmlJson", "portalName" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/infra/cache/frontend/clear": { "post": { "operationId": "infra.cache.frontend.clear", "summary": "infra cache frontend clear", "description": "Endpoint POST /infra/cache/frontend/clear. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/infra/cache/all/clear": { "post": { "operationId": "infra.cache.all.clear", "summary": "infra cache all clear", "description": "Endpoint POST /infra/cache/all/clear. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } }, "/system/getChangelog": { "post": { "operationId": "system.getChangelog", "summary": "system get Changelog", "description": "Endpoint POST /system/getChangelog. Consulte os schemas de entrada e saída para conhecer os campos aceitos e a resposta retornada.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "enum": [ "admin", "partner", "user" ], "type": "string", "default": "user" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ {}, { "not": {} } ] } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "RELAND API token", "description": "Use Authorization: Bearer for operations that require an authenticated user." } } } }