{ "info": { "name": "ImobyFlow API (English)", "_postman_id": "6b1d2c84-0f3a-4c8e-9e1a-5d7b3f2a9c11", "description": "The ImobyFlow integration API (version 1.0.0). Put your key in the `apiKey` environment variable. Writes come in dry-run mode (`dryRun=true`): nothing is written until you remove the parameter. Docs: https://imobyflow.com.br/en/developers", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.imobyflow.com.br/v1", "type": "string" } ], "item": [ { "name": "Account", "description": "The account that owns the key: plan, property quota, key permissions, limits and monthly usage.", "item": [ { "name": "Who am I", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The first call of every integration: confirms the key works and shows the account, this key's permissions, the limits and monthly usage.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The first call of every integration: confirms the key works and shows the account, this key's permissions, the limits and monthly usage.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"account\": {\n \"id\": \"5c1e2f3a-8b7d-4e21-9f6a-0d2c4b8e7a11\",\n \"name\": \"Sua Imobiliária\",\n \"type\": \"IMOBILIARIA\",\n \"plan\": \"IMOB_20\"\n },\n \"access\": {\n \"status\": \"APPROVED\",\n \"tier\": \"PADRAO\",\n \"pilotUntil\": null,\n \"limits\": {\n \"ratePerSecond\": 10,\n \"burst\": 20,\n \"monthlyQuota\": 300000,\n \"maxKeys\": 4,\n \"maxWebhooks\": 3\n }\n },\n \"key\": {\n \"id\": \"k_3c9f1a2b\",\n \"name\": \"CRM produção\",\n \"scopes\": [\n \"properties:read\",\n \"properties:write\",\n \"leads:read\",\n \"leads:write\",\n \"events:read\"\n ],\n \"expiresAt\": null\n },\n \"usage\": {\n \"month\": \"2026-10\",\n \"calls\": 1840,\n \"monthlyQuota\": 300000,\n \"remaining\": 298160\n },\n \"properties\": {\n \"active\": 1840,\n \"limit\": 2000\n }\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The first call of every integration: confirms the key works and shows the account, this key's permissions, the limits and monthly usage.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The first call of every integration: confirms the key works and shows the account, this key's permissions, the limits and monthly usage.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Reference lists", "description": "The accepted values for each code field: property types, purposes, statuses, stages, permissions and events. They are the SAME values stored by the platform — there is no translation layer.", "item": [ { "name": "Property types", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Categories and subtypes. The subtype is what goes in the `type` field.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/property-types", "host": [ "{{baseUrl}}" ], "path": [ "reference", "property-types" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Categories and subtypes. The subtype is what goes in the `type` field.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/property-types", "host": [ "{{baseUrl}}" ], "path": [ "reference", "property-types" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"category\": \"RESIDENCIAL\",\n \"label\": \"Residencial\",\n \"types\": [\n {\n \"value\": \"APARTAMENTO\",\n \"label\": \"Apartamento\"\n }\n ]\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Categories and subtypes. The subtype is what goes in the `type` field.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/property-types", "host": [ "{{baseUrl}}" ], "path": [ "reference", "property-types" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Categories and subtypes. The subtype is what goes in the `type` field.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/property-types", "host": [ "{{baseUrl}}" ], "path": [ "reference", "property-types" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Purposes", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Sale and rent.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/purposes", "host": [ "{{baseUrl}}" ], "path": [ "reference", "purposes" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Sale and rent.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/purposes", "host": [ "{{baseUrl}}" ], "path": [ "reference", "purposes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"value\": \"VENDA\",\n \"label\": \"Venda\"\n },\n {\n \"value\": \"LOCACAO\",\n \"label\": \"Locação\"\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Sale and rent.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/purposes", "host": [ "{{baseUrl}}" ], "path": [ "reference", "purposes" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Sale and rent.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/purposes", "host": [ "{{baseUrl}}" ], "path": [ "reference", "purposes" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Property statuses", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The statuses a property can have.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/property-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "property-statuses" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The statuses a property can have.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/property-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "property-statuses" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"value\": \"ACTIVE\",\n \"label\": \"Disponível\"\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The statuses a property can have.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/property-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "property-statuses" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The statuses a property can have.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/property-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "property-statuses" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Client stages", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The funnel stages.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/lead-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "lead-statuses" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The funnel stages.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/lead-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "lead-statuses" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"value\": \"NEW\",\n \"label\": \"Novo\"\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The funnel stages.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/lead-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "lead-statuses" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The funnel stages.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/lead-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "lead-statuses" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Partnership stages", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership stages.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/partnership-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "partnership-statuses" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership stages.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/partnership-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "partnership-statuses" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"value\": \"NEGOTIATING\",\n \"label\": \"Em negociação\"\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership stages.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/partnership-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "partnership-statuses" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership stages.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/partnership-statuses", "host": [ "{{baseUrl}}" ], "path": [ "reference", "partnership-statuses" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Construction stages", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The stages of a new development.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/construction-stages", "host": [ "{{baseUrl}}" ], "path": [ "reference", "construction-stages" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The stages of a new development.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/construction-stages", "host": [ "{{baseUrl}}" ], "path": [ "reference", "construction-stages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"value\": \"OFF_PLAN\",\n \"label\": \"Na planta / Em obra\"\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The stages of a new development.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/construction-stages", "host": [ "{{baseUrl}}" ], "path": [ "reference", "construction-stages" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The stages of a new development.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/construction-stages", "host": [ "{{baseUrl}}" ], "path": [ "reference", "construction-stages" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Permissions", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The permissions a key can have.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/scopes", "host": [ "{{baseUrl}}" ], "path": [ "reference", "scopes" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The permissions a key can have.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/scopes", "host": [ "{{baseUrl}}" ], "path": [ "reference", "scopes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"properties:read\",\n \"group\": \"Imóveis\",\n \"label\": \"Ler imóveis\",\n \"description\": \"Carteira, situação no Radar, na curadoria e na confirmação.\"\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The permissions a key can have.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/scopes", "host": [ "{{baseUrl}}" ], "path": [ "reference", "scopes" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The permissions a key can have.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/scopes", "host": [ "{{baseUrl}}" ], "path": [ "reference", "scopes" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Event types", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The events, with the read permission that grants access to each.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/event-types", "host": [ "{{baseUrl}}" ], "path": [ "reference", "event-types" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The events, with the read permission that grants access to each.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/event-types", "host": [ "{{baseUrl}}" ], "path": [ "reference", "event-types" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"type\": \"property.updated\",\n \"scope\": \"properties:read\",\n \"description\": \"Imóvel alterado (campos em changedFields)\"\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The events, with the read permission that grants access to each.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/event-types", "host": [ "{{baseUrl}}" ], "path": [ "reference", "event-types" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The events, with the read permission that grants access to each.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/reference/event-types", "host": [ "{{baseUrl}}" ], "path": [ "reference", "event-types" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Cities and neighborhoods", "description": "The location catalog: city by its IBGE code and neighborhood by its catalog identifier. Neighborhoods are closed against the catalog — that is what lets a property into recommendations.", "item": [ { "name": "Cities", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog cities, with their IBGE code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities" ], "query": [ { "key": "uf", "value": "", "description": "Only one state (2 letters).", "disabled": true }, { "key": "q", "value": "", "description": "Part of the name (accents ignored).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog cities, with their IBGE code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities" ], "query": [ { "key": "uf", "value": "", "description": "Only one state (2 letters).", "disabled": true }, { "key": "q", "value": "", "description": "Part of the name (accents ignored).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"cityId\": \"4106902\",\n \"name\": \"Curitiba\",\n \"uf\": \"PR\",\n \"citySlug\": \"curitiba\"\n }\n ],\n \"nextCursor\": null,\n \"total\": 1\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog cities, with their IBGE code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities" ], "query": [ { "key": "uf", "value": "", "description": "Only one state (2 letters).", "disabled": true }, { "key": "q", "value": "", "description": "Part of the name (accents ignored).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog cities, with their IBGE code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities" ], "query": [ { "key": "uf", "value": "", "description": "Only one state (2 letters).", "disabled": true }, { "key": "q", "value": "", "description": "Part of the name (accents ignored).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog cities, with their IBGE code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities" ], "query": [ { "key": "uf", "value": "", "description": "Only one state (2 letters).", "disabled": true }, { "key": "q", "value": "", "description": "Part of the name (accents ignored).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "A city's neighborhoods", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog neighborhoods. The `neighborhoodSlug` from here is what guarantees the property enters recommendations.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities/:cityId/neighborhoods", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities", ":cityId", "neighborhoods" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "cityId", "value": "4106902", "description": "IBGE code (7 digits)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog neighborhoods. The `neighborhoodSlug` from here is what guarantees the property enters recommendations.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities/:cityId/neighborhoods", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities", ":cityId", "neighborhoods" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "cityId", "value": "4106902", "description": "IBGE code (7 digits)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"neighborhoodSlug\": \"bigorrilho\",\n \"name\": \"Bigorrilho\"\n }\n ],\n \"nextCursor\": \"2s\",\n \"total\": 75\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog neighborhoods. The `neighborhoodSlug` from here is what guarantees the property enters recommendations.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities/:cityId/neighborhoods", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities", ":cityId", "neighborhoods" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "cityId", "value": "4106902", "description": "IBGE code (7 digits)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog neighborhoods. The `neighborhoodSlug` from here is what guarantees the property enters recommendations.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities/:cityId/neighborhoods", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities", ":cityId", "neighborhoods" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "cityId", "value": "4106902", "description": "IBGE code (7 digits)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog neighborhoods. The `neighborhoodSlug` from here is what guarantees the property enters recommendations.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities/:cityId/neighborhoods", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities", ":cityId", "neighborhoods" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "cityId", "value": "4106902", "description": "IBGE code (7 digits)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Catalog neighborhoods. The `neighborhoodSlug` from here is what guarantees the property enters recommendations.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/geo/cities/:cityId/neighborhoods", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities", ":cityId", "neighborhoods" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 1000 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "cityId", "value": "4106902", "description": "IBGE code (7 digits)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Properties", "description": "The account's portfolio: read, sync by your system's code, change status, confirm availability, send photos by URL and move to the trash.", "item": [ { "name": "List the portfolio", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"kind\": \"PROPERTY\",\n \"developmentId\": null,\n \"status\": \"ACTIVE\",\n \"type\": \"APARTAMENTO\",\n \"category\": \"RESIDENCIAL\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"rentPrice\": null,\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"description\": \"Sol da manhã, duas vagas e lazer completo.\",\n \"address\": {\n \"neighborhood\": \"Bigorrilho\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"privateArea\": 92,\n \"amenities\": [\n \"Piscina\",\n \"Academia\"\n ],\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"photos\": [\n \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\"\n ],\n \"listingUrl\": \"https://www.suaimobiliaria.com.br/imovel/AP1234\",\n \"captador\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\"\n },\n \"captadorName\": null,\n \"sharedToNetwork\": true,\n \"partnershipTerms\": {\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"curation\": {\n \"status\": \"APPROVED\",\n \"reason\": null,\n \"label\": null\n },\n \"confirmation\": {\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"dueAt\": \"2026-12-01T16:45:12.000Z\",\n \"noticeAt\": null,\n \"offlineAt\": null\n },\n \"inactiveReason\": null,\n \"deletedAt\": null,\n \"launch\": null,\n \"photoSync\": {\n \"state\": \"DONE\",\n \"requested\": 1,\n \"ingested\": 1,\n \"failed\": 0,\n \"queuedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n ],\n \"nextCursor\": \"eyJhIjoiNWMxZS4uLiJ9\"\n}" }, { "name": "400 · invalid_cursor", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-cursor\",\n \"title\": \"Invalid cursor — restart the listing without it\",\n \"status\": 400,\n \"code\": \"invalid_cursor\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "503 · upstream_busy", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-busy\",\n \"title\": \"Too many concurrent requests — retry shortly\",\n \"status\": 503,\n \"code\": \"upstream_busy\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "504 · upstream_timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's portfolio, newest first, with filters. To sync, use `updatedSince` — or the events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status (`DELETED` = trash).", "disabled": true }, { "key": "purpose", "value": "", "description": "Purpose.", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-timeout\",\n \"title\": \"The query took too long — try a smaller page\",\n \"status\": 504,\n \"code\": \"upstream_timeout\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "One property by your code", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property by your system's code (`externalRef`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property by your system's code (`externalRef`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"kind\": \"PROPERTY\",\n \"developmentId\": null,\n \"status\": \"ACTIVE\",\n \"type\": \"APARTAMENTO\",\n \"category\": \"RESIDENCIAL\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"rentPrice\": null,\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"description\": \"Sol da manhã, duas vagas e lazer completo.\",\n \"address\": {\n \"neighborhood\": \"Bigorrilho\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"privateArea\": 92,\n \"amenities\": [\n \"Piscina\",\n \"Academia\"\n ],\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"photos\": [\n \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\"\n ],\n \"listingUrl\": \"https://www.suaimobiliaria.com.br/imovel/AP1234\",\n \"captador\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\"\n },\n \"captadorName\": null,\n \"sharedToNetwork\": true,\n \"partnershipTerms\": {\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"curation\": {\n \"status\": \"APPROVED\",\n \"reason\": null,\n \"label\": null\n },\n \"confirmation\": {\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"dueAt\": \"2026-12-01T16:45:12.000Z\",\n \"noticeAt\": null,\n \"offlineAt\": null\n },\n \"inactiveReason\": null,\n \"deletedAt\": null,\n \"launch\": null,\n \"photoSync\": {\n \"state\": \"DONE\",\n \"requested\": 1,\n \"ingested\": 1,\n \"failed\": 0,\n \"queuedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property by your system's code (`externalRef`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property by your system's code (`externalRef`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property by your system's code (`externalRef`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property by your system's code (`externalRef`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "One property", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property, with its recommendation, review and confirmation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property, with its recommendation, review and confirmation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"kind\": \"PROPERTY\",\n \"developmentId\": null,\n \"status\": \"ACTIVE\",\n \"type\": \"APARTAMENTO\",\n \"category\": \"RESIDENCIAL\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"rentPrice\": null,\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"description\": \"Sol da manhã, duas vagas e lazer completo.\",\n \"address\": {\n \"neighborhood\": \"Bigorrilho\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"privateArea\": 92,\n \"amenities\": [\n \"Piscina\",\n \"Academia\"\n ],\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"photos\": [\n \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\"\n ],\n \"listingUrl\": \"https://www.suaimobiliaria.com.br/imovel/AP1234\",\n \"captador\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\"\n },\n \"captadorName\": null,\n \"sharedToNetwork\": true,\n \"partnershipTerms\": {\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"curation\": {\n \"status\": \"APPROVED\",\n \"reason\": null,\n \"label\": null\n },\n \"confirmation\": {\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"dueAt\": \"2026-12-01T16:45:12.000Z\",\n \"noticeAt\": null,\n \"offlineAt\": null\n },\n \"inactiveReason\": null,\n \"deletedAt\": null,\n \"launch\": null,\n \"photoSync\": {\n \"state\": \"DONE\",\n \"requested\": 1,\n \"ingested\": 1,\n \"failed\": 0,\n \"queuedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property, with its recommendation, review and confirmation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property, with its recommendation, review and confirmation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property, with its recommendation, review and confirmation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The property, with its recommendation, review and confirmation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Feed sync status", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "How the last CRM link sync ended and whether another is scheduled — to check the result after a `POST /v1/feed/sync`. Never includes the link or the token.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed", "host": [ "{{baseUrl}}" ], "path": [ "feed" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "How the last CRM link sync ended and whether another is scheduled — to check the result after a `POST /v1/feed/sync`. Never includes the link or the token.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed", "host": [ "{{baseUrl}}" ], "path": [ "feed" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"configured\": true,\n \"connector\": \"vista\",\n \"autoSync\": true,\n \"status\": \"OK\",\n \"message\": \"412 imóveis conferidos.\",\n \"lastSyncAt\": \"2026-10-01T13:20:00.000Z\",\n \"feedCount\": 412,\n \"counts\": {\n \"created\": 2,\n \"updated\": 5,\n \"archived\": 0,\n \"skipped\": 1,\n \"unchanged\": 404,\n \"confirmed\": 0\n },\n \"conflicts\": 0,\n \"scheduledFor\": null\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "How the last CRM link sync ended and whether another is scheduled — to check the result after a `POST /v1/feed/sync`. Never includes the link or the token.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed", "host": [ "{{baseUrl}}" ], "path": [ "feed" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "How the last CRM link sync ended and whether another is scheduled — to check the result after a `POST /v1/feed/sync`. Never includes the link or the token.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed", "host": [ "{{baseUrl}}" ], "path": [ "feed" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "How the last CRM link sync ended and whether another is scheduled — to check the result after a `POST /v1/feed/sync`. Never includes the link or the token.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed", "host": [ "{{baseUrl}}" ], "path": [ "feed" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Sync the feed now", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "response": [ { "name": "202 · Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"configured\": true,\n \"connector\": \"vista\",\n \"autoSync\": true,\n \"status\": \"QUEUED\",\n \"message\": \"Sincronização em andamento…\",\n \"lastSyncAt\": \"2026-10-01T13:20:00.000Z\",\n \"feedCount\": 412,\n \"counts\": {\n \"created\": 2,\n \"updated\": 5,\n \"archived\": 0,\n \"skipped\": 1,\n \"unchanged\": 404,\n \"confirmed\": 0\n },\n \"conflicts\": 0,\n \"scheduledFor\": null\n },\n \"result\": {\n \"outcome\": \"QUEUED\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · feed_not_configured", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/feed-not-configured\",\n \"title\": \"The CRM feed link is not set up for this account\",\n \"status\": 409,\n \"code\": \"feed_not_configured\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Call it after changing the portfolio in your CRM: ImobyFlow fetches the SAME feed link, through the same 6-hourly sync — only what changed is written. The first call in each 10-minute window syncs right away; later ones leave ONE sync scheduled for the end of the window, so no change waits 6 hours and calling on every change overloads nothing. Follow it with `GET /v1/feed` or the property events.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/feed/sync?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "feed", "sync" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Create or update by your code", "request": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"kind\": \"PROPERTY\",\n \"developmentId\": null,\n \"status\": \"ACTIVE\",\n \"type\": \"APARTAMENTO\",\n \"category\": \"RESIDENCIAL\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"rentPrice\": null,\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"description\": \"Sol da manhã, duas vagas e lazer completo.\",\n \"address\": {\n \"neighborhood\": \"Bigorrilho\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"privateArea\": 92,\n \"amenities\": [\n \"Piscina\",\n \"Academia\"\n ],\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"photos\": [\n \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\"\n ],\n \"listingUrl\": \"https://www.suaimobiliaria.com.br/imovel/AP1234\",\n \"captador\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\"\n },\n \"captadorName\": null,\n \"sharedToNetwork\": true,\n \"partnershipTerms\": {\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"curation\": {\n \"status\": \"APPROVED\",\n \"reason\": null,\n \"label\": null\n },\n \"confirmation\": {\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"dueAt\": \"2026-12-01T16:45:12.000Z\",\n \"noticeAt\": null,\n \"offlineAt\": null\n },\n \"inactiveReason\": null,\n \"deletedAt\": null,\n \"launch\": null,\n \"photoSync\": {\n \"state\": \"DONE\",\n \"requested\": 1,\n \"ingested\": 1,\n \"failed\": 0,\n \"queuedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"UPDATED\",\n \"dryRun\": false,\n \"conflicts\": [],\n \"photos\": \"QUEUED\"\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · concurrent_write", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/concurrent-write\",\n \"title\": \"Another write for this code is in progress — retry\",\n \"status\": 409,\n \"code\": \"concurrent_write\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · feed_sync_active", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/feed-sync-active\",\n \"title\": \"Automatic CRM feed sync is on for this account\",\n \"status\": 409,\n \"code\": \"feed_sync_active\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · plan_limit_reached", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/plan-limit-reached\",\n \"title\": \"Plan limit of active properties reached\",\n \"status\": 409,\n \"code\": \"plan_limit_reached\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · property_in_trash", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/property-in-trash\",\n \"title\": \"Property is in the trash\",\n \"status\": 409,\n \"code\": \"property_in_trash\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · invalid_property", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-property\",\n \"title\": \"Incomplete or inconsistent property\",\n \"status\": 422,\n \"code\": \"invalid_property\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "504 · upstream_timeout", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The natural sync path: creates the property when the code is new (201) or updates the existing one (200). Absent fields are kept; nothing changed = `UNCHANGED`, nothing written. Edits made in the dashboard win and come back in `result.conflicts`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "AP1234", "description": "The property's code in your system (up to 80 characters; encode spaces and `/`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-timeout\",\n \"title\": \"The query took too long — try a smaller page\",\n \"status\": 504,\n \"code\": \"upstream_timeout\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Create a property", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 · Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"kind\": \"PROPERTY\",\n \"developmentId\": null,\n \"status\": \"ACTIVE\",\n \"type\": \"APARTAMENTO\",\n \"category\": \"RESIDENCIAL\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"rentPrice\": null,\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"description\": \"Sol da manhã, duas vagas e lazer completo.\",\n \"address\": {\n \"neighborhood\": \"Bigorrilho\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"privateArea\": 92,\n \"amenities\": [\n \"Piscina\",\n \"Academia\"\n ],\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"photos\": [\n \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\"\n ],\n \"listingUrl\": \"https://www.suaimobiliaria.com.br/imovel/AP1234\",\n \"captador\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\"\n },\n \"captadorName\": null,\n \"sharedToNetwork\": true,\n \"partnershipTerms\": {\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"curation\": {\n \"status\": \"APPROVED\",\n \"reason\": null,\n \"label\": null\n },\n \"confirmation\": {\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"dueAt\": \"2026-12-01T16:45:12.000Z\",\n \"noticeAt\": null,\n \"offlineAt\": null\n },\n \"inactiveReason\": null,\n \"deletedAt\": null,\n \"launch\": null,\n \"photoSync\": {\n \"state\": \"DONE\",\n \"requested\": 1,\n \"ingested\": 1,\n \"failed\": 0,\n \"queuedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"CREATED\",\n \"dryRun\": false,\n \"conflicts\": [],\n \"photos\": \"QUEUED\"\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · concurrent_write", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/concurrent-write\",\n \"title\": \"Another write for this code is in progress — retry\",\n \"status\": 409,\n \"code\": \"concurrent_write\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · external_ref_exists", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/external-ref-exists\",\n \"title\": \"A property with this code already exists\",\n \"status\": 409,\n \"code\": \"external_ref_exists\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · feed_sync_active", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/feed-sync-active\",\n \"title\": \"Automatic CRM feed sync is on for this account\",\n \"status\": 409,\n \"code\": \"feed_sync_active\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · plan_limit_reached", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/plan-limit-reached\",\n \"title\": \"Plan limit of active properties reached\",\n \"status\": 409,\n \"code\": \"plan_limit_reached\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · invalid_property", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-property\",\n \"title\": \"Incomplete or inconsistent property\",\n \"status\": 422,\n \"code\": \"invalid_property\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a property. Minimum: `type`, `purposes`, the price for each purpose and the address with the city. An existing code → 409 with the id.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Partially update a property", "request": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"kind\": \"PROPERTY\",\n \"developmentId\": null,\n \"status\": \"ACTIVE\",\n \"type\": \"APARTAMENTO\",\n \"category\": \"RESIDENCIAL\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"rentPrice\": null,\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"description\": \"Sol da manhã, duas vagas e lazer completo.\",\n \"address\": {\n \"neighborhood\": \"Bigorrilho\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"privateArea\": 92,\n \"amenities\": [\n \"Piscina\",\n \"Academia\"\n ],\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"photos\": [\n \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\"\n ],\n \"listingUrl\": \"https://www.suaimobiliaria.com.br/imovel/AP1234\",\n \"captador\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\"\n },\n \"captadorName\": null,\n \"sharedToNetwork\": true,\n \"partnershipTerms\": {\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"curation\": {\n \"status\": \"APPROVED\",\n \"reason\": null,\n \"label\": null\n },\n \"confirmation\": {\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"dueAt\": \"2026-12-01T16:45:12.000Z\",\n \"noticeAt\": null,\n \"offlineAt\": null\n },\n \"inactiveReason\": null,\n \"deletedAt\": null,\n \"launch\": null,\n \"photoSync\": {\n \"state\": \"DONE\",\n \"requested\": 1,\n \"ingested\": 1,\n \"failed\": 0,\n \"queuedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"UPDATED\",\n \"dryRun\": false,\n \"conflicts\": [],\n \"photos\": \"QUEUED\"\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · feed_sync_active", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/feed-sync-active\",\n \"title\": \"Automatic CRM feed sync is on for this account\",\n \"status\": 409,\n \"code\": \"feed_sync_active\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · property_in_trash", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/property-in-trash\",\n \"title\": \"Property is in the trash\",\n \"status\": 409,\n \"code\": \"property_in_trash\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · invalid_property", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-property\",\n \"title\": \"Incomplete or inconsistent property\",\n \"status\": 422,\n \"code\": \"invalid_property\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. To clear a field, send `null`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"salePrice\": 870000\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Change the status", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"kind\": \"PROPERTY\",\n \"developmentId\": null,\n \"status\": \"SOLD\",\n \"type\": \"APARTAMENTO\",\n \"category\": \"RESIDENCIAL\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"rentPrice\": null,\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"description\": \"Sol da manhã, duas vagas e lazer completo.\",\n \"address\": {\n \"neighborhood\": \"Bigorrilho\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"privateArea\": 92,\n \"amenities\": [\n \"Piscina\",\n \"Academia\"\n ],\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"photos\": [\n \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\"\n ],\n \"listingUrl\": \"https://www.suaimobiliaria.com.br/imovel/AP1234\",\n \"captador\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\"\n },\n \"captadorName\": null,\n \"sharedToNetwork\": true,\n \"partnershipTerms\": {\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"curation\": {\n \"status\": \"APPROVED\",\n \"reason\": null,\n \"label\": null\n },\n \"confirmation\": {\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"dueAt\": \"2026-12-01T16:45:12.000Z\",\n \"noticeAt\": null,\n \"offlineAt\": null\n },\n \"inactiveReason\": null,\n \"deletedAt\": null,\n \"launch\": null,\n \"photoSync\": {\n \"state\": \"DONE\",\n \"requested\": 1,\n \"ingested\": 1,\n \"failed\": 0,\n \"queuedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"STATUS_SET\",\n \"dryRun\": false,\n \"conflicts\": [],\n \"photos\": null\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · plan_limit_reached", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/plan-limit-reached\",\n \"title\": \"Plan limit of active properties reached\",\n \"status\": 409,\n \"code\": \"plan_limit_reached\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Available, archived, sold or rented — the same function as the dashboard: only available ones use the plan quota, and partners negotiating it are notified. Sold does not come back through the feed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"SOLD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Confirm availability in bulk", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"ref\": \"AP1234\",\n \"propertyId\": \"prop-3f9a1c2b7d4e\",\n \"outcome\": \"CONFIRMED\"\n },\n {\n \"ref\": \"CA0042\",\n \"propertyId\": null,\n \"outcome\": \"NOT_FOUND\"\n }\n ],\n \"result\": {\n \"dryRun\": false,\n \"summary\": {\n \"CONFIRMED\": 1,\n \"NOT_FOUND\": 1\n }\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "The 60-day rule takes unconfirmed properties offline. Send up to 200 `ids` and `refs`; confirmed less than 24 h ago is not rewritten (`ALREADY_CONFIRMED`).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/confirm?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "confirm" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"refs\": [\n \"AP1234\",\n \"CA0042\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Move to the trash", "request": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"kind\": \"PROPERTY\",\n \"developmentId\": null,\n \"status\": \"DELETED\",\n \"type\": \"APARTAMENTO\",\n \"category\": \"RESIDENCIAL\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"rentPrice\": null,\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"description\": \"Sol da manhã, duas vagas e lazer completo.\",\n \"address\": {\n \"neighborhood\": \"Bigorrilho\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"privateArea\": 92,\n \"amenities\": [\n \"Piscina\",\n \"Academia\"\n ],\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"photos\": [\n \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\"\n ],\n \"listingUrl\": \"https://www.suaimobiliaria.com.br/imovel/AP1234\",\n \"captador\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\"\n },\n \"captadorName\": null,\n \"sharedToNetwork\": true,\n \"partnershipTerms\": {\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"curation\": {\n \"status\": \"APPROVED\",\n \"reason\": null,\n \"label\": null\n },\n \"confirmation\": {\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"dueAt\": \"2026-12-01T16:45:12.000Z\",\n \"noticeAt\": null,\n \"offlineAt\": null\n },\n \"inactiveReason\": null,\n \"deletedAt\": \"2026-10-02T16:45:12.000Z\",\n \"launch\": null,\n \"photoSync\": {\n \"state\": \"DONE\",\n \"requested\": 1,\n \"ingested\": 1,\n \"failed\": 0,\n \"queuedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"DELETED\",\n \"dryRun\": false,\n \"conflicts\": [],\n \"photos\": null\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · feed_sync_active", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/feed-sync-active\",\n \"title\": \"Automatic CRM feed sync is on for this account\",\n \"status\": 409,\n \"code\": \"feed_sync_active\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · shrink_guard", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/shrink-guard\",\n \"title\": \"Shrink guard: too many deletions in 24 hours\",\n \"status\": 409,\n \"code\": \"shrink_guard\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash (restorable in the dashboard). Shrink guard: at most 20% of the portfolio (and at least 10) in 24 hours — a loop in your system cannot empty the portfolio. With the CRM feed on, the feed is the one that takes properties offline.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Clients", "description": "The account's clients, with the search profile that drives recommendations: read, sync by your system's code, move through the funnel, archive and log interactions.", "item": [ { "name": "List clients", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"ACTIVE\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": null,\n \"archivedReason\": null,\n \"deletedAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n ],\n \"nextCursor\": \"eyJhIjoiNWMxZS4uLiJ9\"\n}" }, { "name": "400 · invalid_cursor", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-cursor\",\n \"title\": \"Invalid cursor — restart the listing without it\",\n \"status\": 400,\n \"code\": \"invalid_cursor\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "503 · upstream_busy", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-busy\",\n \"title\": \"Too many concurrent requests — retry shortly\",\n \"status\": 503,\n \"code\": \"upstream_busy\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "504 · upstream_timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's clients, newest first, with filters.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "state", "value": "", "description": "`ACTIVE` (default), `ARCHIVED` or `DELETED`.", "disabled": true }, { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true }, { "key": "radar", "value": "", "description": "`pending` = only items with recommendation pending items; `ready` = only ready items.", "disabled": true } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-timeout\",\n \"title\": \"The query took too long — try a smaller page\",\n \"status\": 504,\n \"code\": \"upstream_timeout\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "One client", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client, with the search profile and recommendation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client, with the search profile and recommendation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"ACTIVE\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": null,\n \"archivedReason\": null,\n \"deletedAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client, with the search profile and recommendation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client, with the search profile and recommendation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client, with the search profile and recommendation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client, with the search profile and recommendation status.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "One client by your code", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client by your system's code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client by your system's code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"ACTIVE\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": null,\n \"archivedReason\": null,\n \"deletedAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client by your system's code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client by your system's code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client by your system's code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The client by your system's code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Create, update or link by your code", "request": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"ACTIVE\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": null,\n \"archivedReason\": null,\n \"deletedAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"UPDATED\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · concurrent_write", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/concurrent-write\",\n \"title\": \"Another write for this code is in progress — retry\",\n \"status\": 409,\n \"code\": \"concurrent_write\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · external_ref_exists", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/external-ref-exists\",\n \"title\": \"A property with this code already exists\",\n \"status\": 409,\n \"code\": \"external_ref_exists\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · lead_in_trash", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/lead-in-trash\",\n \"title\": \"Client is in the trash\",\n \"status\": 409,\n \"code\": \"lead_in_trash\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · lead_linked_to_other_ref", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/lead-linked-to-other-ref\",\n \"title\": \"The client with this contact already has another CRM code\",\n \"status\": 409,\n \"code\": \"lead_linked_to_other_ref\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · consent_required", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/consent-required\",\n \"title\": \"Client consent not declared\",\n \"status\": 422,\n \"code\": \"consent_required\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (`LINKED`), without a second client. On creation, `consentGiven: true` is required.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/by-ref/:ref?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "by-ref", ":ref" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "ref", "value": "CLI-889", "description": "The client's code in your system (up to 80 characters)." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Create a client", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 · Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"ACTIVE\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": null,\n \"archivedReason\": null,\n \"deletedAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"CREATED\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · concurrent_write", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/concurrent-write\",\n \"title\": \"Another write for this code is in progress — retry\",\n \"status\": 409,\n \"code\": \"concurrent_write\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · external_ref_exists", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/external-ref-exists\",\n \"title\": \"A property with this code already exists\",\n \"status\": 409,\n \"code\": \"external_ref_exists\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · lead_exists", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/lead-exists\",\n \"title\": \"A client with this phone or e-mail already exists\",\n \"status\": 409,\n \"code\": \"lead_exists\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · consent_required", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/consent-required\",\n \"title\": \"Client consent not declared\",\n \"status\": 422,\n \"code\": \"consent_required\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Creates a client. Minimum: `name`, a phone or e-mail and `consentGiven: true`. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Partially update a client", "request": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"ACTIVE\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": null,\n \"archivedReason\": null,\n \"deletedAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"UPDATED\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · lead_in_trash", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/lead-in-trash\",\n \"title\": \"Client is in the trash\",\n \"status\": 409,\n \"code\": \"lead_in_trash\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes only what is sent. Changing the stage is logged but does not count as activity — for that send `lastActivityAt` or log an interaction.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\",\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Archive or reactivate", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"ARCHIVED\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedReason\": \"MANUAL\",\n \"deletedAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"STATE_SET\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · lead_in_trash", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/lead-in-trash\",\n \"title\": \"Client is in the trash\",\n \"status\": 409,\n \"code\": \"lead_in_trash\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "`ARCHIVED` archives; `ACTIVE` reactivates. The same function as the dashboard.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/state?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "state" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"state\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Log an interaction", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"ACTIVE\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": null,\n \"archivedReason\": null,\n \"deletedAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"ADDED\",\n \"dryRun\": false,\n \"interaction\": {\n \"id\": \"int-1a2b3c\",\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00.000Z\"\n }\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/interactions?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "interactions" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"VISIT\",\n \"note\": \"Visitou o AP1234 com a esposa.\",\n \"at\": \"2026-10-02T15:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Move to the trash", "request": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"externalRef\": \"CLI-889\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"state\": \"DELETED\",\n \"status\": \"ATTENDING\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"41999998888\",\n \"isWhatsApp\": true,\n \"label\": null\n }\n ],\n \"email\": \"carlos@example.com\",\n \"source\": \"CRM_API\",\n \"sourceDetail\": \"Vista / Loft CRM\",\n \"sourcePropertyId\": null,\n \"preApproved\": false,\n \"sharedToNetwork\": true,\n \"notes\": null,\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"cityName\": \"Curitiba\",\n \"uf\": \"PR\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"neighborhoodName\": \"Bigorrilho\",\n \"preference\": \"PREFERRED\"\n }\n ],\n \"similarNeighborhoods\": true,\n \"salePriceMin\": 600000,\n \"salePriceMax\": 950000,\n \"rentPriceMin\": null,\n \"rentPriceMax\": null,\n \"bedrooms\": 3,\n \"bathrooms\": null,\n \"parkingSpots\": 2,\n \"areaMin\": 80\n },\n \"radar\": {\n \"eligible\": true,\n \"pending\": [],\n \"labels\": []\n },\n \"lastActivityAt\": \"2026-10-02T16:45:12.000Z\",\n \"archivedAt\": null,\n \"archivedReason\": null,\n \"deletedAt\": \"2026-10-02T16:45:12.000Z\",\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"DELETED\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · shrink_guard", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/shrink-guard\",\n \"title\": \"Shrink guard: too many deletions in 24 hours\",\n \"status\": 409,\n \"code\": \"shrink_guard\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Opportunities (Radar)", "description": "The opportunities Radar finds between properties and clients — in the account itself and with partners — under the same display rules as the dashboard.", "item": [ { "name": "A property's opportunities", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The clients that fit the property. Only the account's own clients — partner clients never show up on your property.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/matches", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "matches" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The clients that fit the property. Only the account's own clients — partner clients never show up on your property.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/matches", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "matches" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"m#prop-3f9a1c2b7d4e#lead-7c2e9a1b3d5f#L\",\n \"scope\": \"INTERNAL\",\n \"status\": \"NEW\",\n \"score\": 87,\n \"reasons\": [\n \"Bairro preferido\",\n \"Dentro do orçamento\"\n ],\n \"gaps\": [],\n \"propertyId\": \"prop-3f9a1c2b7d4e\",\n \"leadId\": \"lead-7c2e9a1b3d5f\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"ownerName\": \"Marina Souza\",\n \"locked\": false,\n \"lostRelevance\": false,\n \"property\": {\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purpose\": \"VENDA\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"price\": 890000,\n \"priceFrom\": false,\n \"rentPrice\": null,\n \"city\": \"Curitiba\",\n \"neighborhood\": \"Bigorrilho\",\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"listingUrl\": null,\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50,\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"deliveryDate\": null,\n \"developmentId\": null,\n \"developmentName\": null\n },\n \"client\": {\n \"masked\": false,\n \"status\": \"ATTENDING\",\n \"preApproved\": false,\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"regions\": [\n \"Bigorrilho, Curitiba\"\n ],\n \"priceMin\": 600000,\n \"priceMax\": 950000,\n \"bedrooms\": 3,\n \"parkingSpots\": 2,\n \"areaMin\": 80,\n \"name\": \"Carlos Pereira\"\n },\n \"counterpart\": null,\n \"createdAt\": \"2026-10-02T16:45:12.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n ],\n \"nextCursor\": \"eyJhIjoiNWMxZS4uLiJ9\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The clients that fit the property. Only the account's own clients — partner clients never show up on your property.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/matches", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "matches" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The clients that fit the property. Only the account's own clients — partner clients never show up on your property.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/matches", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "matches" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The clients that fit the property. Only the account's own clients — partner clients never show up on your property.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/matches", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "matches" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The clients that fit the property. Only the account's own clients — partner clients never show up on your property.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/:propertyId/matches", "host": [ "{{baseUrl}}" ], "path": [ "properties", ":propertyId", "matches" ], "variable": [ { "key": "propertyId", "value": "prop-3f9a1c2b7d4e", "description": "Property id (`prop-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "A client's opportunities", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The properties that fit the client — own and from partners.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/matches", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "matches" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The properties that fit the client — own and from partners.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/matches", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "matches" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"m#prop-3f9a1c2b7d4e#lead-7c2e9a1b3d5f#L\",\n \"scope\": \"INTERNAL\",\n \"status\": \"NEW\",\n \"score\": 87,\n \"reasons\": [\n \"Bairro preferido\",\n \"Dentro do orçamento\"\n ],\n \"gaps\": [],\n \"propertyId\": \"prop-3f9a1c2b7d4e\",\n \"leadId\": \"lead-7c2e9a1b3d5f\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"ownerName\": \"Marina Souza\",\n \"locked\": false,\n \"lostRelevance\": false,\n \"property\": {\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purpose\": \"VENDA\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"price\": 890000,\n \"priceFrom\": false,\n \"rentPrice\": null,\n \"city\": \"Curitiba\",\n \"neighborhood\": \"Bigorrilho\",\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"listingUrl\": null,\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50,\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"deliveryDate\": null,\n \"developmentId\": null,\n \"developmentName\": null\n },\n \"client\": {\n \"masked\": false,\n \"status\": \"ATTENDING\",\n \"preApproved\": false,\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"regions\": [\n \"Bigorrilho, Curitiba\"\n ],\n \"priceMin\": 600000,\n \"priceMax\": 950000,\n \"bedrooms\": 3,\n \"parkingSpots\": 2,\n \"areaMin\": 80,\n \"name\": \"Carlos Pereira\"\n },\n \"counterpart\": null,\n \"createdAt\": \"2026-10-02T16:45:12.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n ],\n \"nextCursor\": \"eyJhIjoiNWMxZS4uLiJ9\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The properties that fit the client — own and from partners.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/matches", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "matches" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The properties that fit the client — own and from partners.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/matches", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "matches" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The properties that fit the client — own and from partners.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/matches", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "matches" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The properties that fit the client — own and from partners.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/:leadId/matches", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":leadId", "matches" ], "variable": [ { "key": "leadId", "value": "lead-7c2e9a1b3d5f", "description": "Client id (`lead-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "The account's opportunities", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"m#prop-3f9a1c2b7d4e#lead-7c2e9a1b3d5f#L\",\n \"scope\": \"INTERNAL\",\n \"status\": \"NEW\",\n \"score\": 87,\n \"reasons\": [\n \"Bairro preferido\",\n \"Dentro do orçamento\"\n ],\n \"gaps\": [],\n \"propertyId\": \"prop-3f9a1c2b7d4e\",\n \"leadId\": \"lead-7c2e9a1b3d5f\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"ownerName\": \"Marina Souza\",\n \"locked\": false,\n \"lostRelevance\": false,\n \"property\": {\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purpose\": \"VENDA\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"price\": 890000,\n \"priceFrom\": false,\n \"rentPrice\": null,\n \"city\": \"Curitiba\",\n \"neighborhood\": \"Bigorrilho\",\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"listingUrl\": null,\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50,\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"deliveryDate\": null,\n \"developmentId\": null,\n \"developmentName\": null\n },\n \"client\": {\n \"masked\": false,\n \"status\": \"ATTENDING\",\n \"preApproved\": false,\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"regions\": [\n \"Bigorrilho, Curitiba\"\n ],\n \"priceMin\": 600000,\n \"priceMax\": 950000,\n \"bedrooms\": 3,\n \"parkingSpots\": 2,\n \"areaMin\": 80,\n \"name\": \"Carlos Pereira\"\n },\n \"counterpart\": null,\n \"createdAt\": \"2026-10-02T16:45:12.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n ],\n \"nextCursor\": \"eyJhIjoiNWMxZS4uLiJ9\"\n}" }, { "name": "400 · invalid_cursor", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-cursor\",\n \"title\": \"Invalid cursor — restart the listing without it\",\n \"status\": 400,\n \"code\": \"invalid_cursor\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "503 · upstream_busy", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-busy\",\n \"title\": \"Too many concurrent requests — retry shortly\",\n \"status\": 503,\n \"code\": \"upstream_busy\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "504 · upstream_timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The opportunities, newest first. Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (`locked`). The client's name only comes with `leads:read` on the key.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches", "host": [ "{{baseUrl}}" ], "path": [ "matches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 100 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "scope", "value": "", "description": "Origin.", "disabled": true }, { "key": "ownerAccountId", "value": "", "description": "Only one broker's items.", "disabled": true } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-timeout\",\n \"title\": \"The query took too long — try a smaller page\",\n \"status\": 504,\n \"code\": \"upstream_timeout\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Dismiss an opportunity", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"m#prop-3f9a1c2b7d4e#lead-7c2e9a1b3d5f#L\",\n \"scope\": \"INTERNAL\",\n \"status\": \"ARCHIVED\",\n \"score\": 87,\n \"reasons\": [\n \"Bairro preferido\",\n \"Dentro do orçamento\"\n ],\n \"gaps\": [],\n \"propertyId\": \"prop-3f9a1c2b7d4e\",\n \"leadId\": \"lead-7c2e9a1b3d5f\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"ownerName\": \"Marina Souza\",\n \"locked\": false,\n \"lostRelevance\": false,\n \"property\": {\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purpose\": \"VENDA\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"price\": 890000,\n \"priceFrom\": false,\n \"rentPrice\": null,\n \"city\": \"Curitiba\",\n \"neighborhood\": \"Bigorrilho\",\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"listingUrl\": null,\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50,\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"deliveryDate\": null,\n \"developmentId\": null,\n \"developmentName\": null\n },\n \"client\": {\n \"masked\": false,\n \"status\": \"ATTENDING\",\n \"preApproved\": false,\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"regions\": [\n \"Bigorrilho, Curitiba\"\n ],\n \"priceMin\": 600000,\n \"priceMax\": 950000,\n \"bedrooms\": 3,\n \"parkingSpots\": 2,\n \"areaMin\": 80,\n \"name\": \"Carlos Pereira\"\n },\n \"counterpart\": null,\n \"createdAt\": \"2026-10-02T16:45:12.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"APPLIED\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The broker's decision, made in your system. A favorited opportunity cannot be dismissed.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/dismiss?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "dismiss" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Restore an opportunity", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"m#prop-3f9a1c2b7d4e#lead-7c2e9a1b3d5f#L\",\n \"scope\": \"INTERNAL\",\n \"status\": \"NEW\",\n \"score\": 87,\n \"reasons\": [\n \"Bairro preferido\",\n \"Dentro do orçamento\"\n ],\n \"gaps\": [],\n \"propertyId\": \"prop-3f9a1c2b7d4e\",\n \"leadId\": \"lead-7c2e9a1b3d5f\",\n \"ownerAccountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"ownerName\": \"Marina Souza\",\n \"locked\": false,\n \"lostRelevance\": false,\n \"property\": {\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purpose\": \"VENDA\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"price\": 890000,\n \"priceFrom\": false,\n \"rentPrice\": null,\n \"city\": \"Curitiba\",\n \"neighborhood\": \"Bigorrilho\",\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"listingUrl\": null,\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50,\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"deliveryDate\": null,\n \"developmentId\": null,\n \"developmentName\": null\n },\n \"client\": {\n \"masked\": false,\n \"status\": \"ATTENDING\",\n \"preApproved\": false,\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"regions\": [\n \"Bigorrilho, Curitiba\"\n ],\n \"priceMin\": 600000,\n \"priceMax\": 950000,\n \"bedrooms\": 3,\n \"parkingSpots\": 2,\n \"areaMin\": 80,\n \"name\": \"Carlos Pereira\"\n },\n \"counterpart\": null,\n \"createdAt\": \"2026-10-02T16:45:12.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"APPLIED\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Brings a dismissed opportunity back to new.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/matches/:matchId/restore?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "matches", ":matchId", "restore" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "matchId", "value": "m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L", "description": "Opportunity id. It contains `#`: send it URL-encoded (`%23`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Partnerships", "description": "The team's partnerships, with the stage and both sides. Only the side that brought the client moves the funnel.", "item": [ { "name": "The team's partnerships", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "All partnerships in one response. `nextCursor` exists in the contract for when it paginates — follow it from day one.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships", "host": [ "{{baseUrl}}" ], "path": [ "partnerships" ], "query": [ { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "All partnerships in one response. `nextCursor` exists in the contract for when it paginates — follow it from day one.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships", "host": [ "{{baseUrl}}" ], "path": [ "partnerships" ], "query": [ { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"pship-5b8d2f1e9a3c\",\n \"status\": \"NEGOTIATING\",\n \"kind\": \"PROPERTY_FOR_CLIENT\",\n \"propertyId\": \"prop-9e8d7c6b5a4f\",\n \"leadId\": \"lead-7c2e9a1b3d5f\",\n \"matchId\": \"m#prop-9e8d7c6b5a4f#lead-7c2e9a1b3d5f#L\",\n \"developmentId\": null,\n \"developmentTitle\": null,\n \"score\": 82,\n \"summary\": \"Apartamento 3 quartos no Batel para Carlos Pereira\",\n \"reasons\": [\n \"Bairro aceitável\"\n ],\n \"message\": \"Tenho um cliente para este imóvel.\",\n \"ourSide\": \"REQUESTER\",\n \"ourBrokerId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"canMoveFunnel\": true,\n \"requester\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\",\n \"type\": \"CORRETOR\"\n },\n \"addressee\": {\n \"accountId\": \"c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f\",\n \"name\": \"Rafael Lima\",\n \"type\": \"CORRETOR\"\n },\n \"counterpart\": {\n \"name\": \"Rafael Lima\",\n \"type\": \"CORRETOR\",\n \"organization\": \"Lima Imóveis\",\n \"contactName\": \"Rafael Lima\",\n \"phone\": \"41988887777\",\n \"email\": \"rafael@example.com\",\n \"creci\": \"F-12345/PR\",\n \"creciVerified\": true\n },\n \"property\": {\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purpose\": \"VENDA\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"price\": 890000,\n \"priceFrom\": false,\n \"rentPrice\": null,\n \"city\": \"Curitiba\",\n \"neighborhood\": \"Bigorrilho\",\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"listingUrl\": null,\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50,\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"deliveryDate\": null,\n \"developmentId\": null,\n \"developmentName\": null\n },\n \"client\": {\n \"masked\": false,\n \"status\": \"ATTENDING\",\n \"preApproved\": false,\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"regions\": [\n \"Bigorrilho, Curitiba\"\n ],\n \"priceMin\": 600000,\n \"priceMax\": 950000,\n \"bedrooms\": 3,\n \"parkingSpots\": 2,\n \"areaMin\": 80,\n \"name\": \"Carlos Pereira\"\n },\n \"lastProgressAt\": \"2026-10-02T16:45:12.000Z\",\n \"protectedUntil\": null,\n \"propertyOffMarketAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n ],\n \"nextCursor\": null\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "All partnerships in one response. `nextCursor` exists in the contract for when it paginates — follow it from day one.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships", "host": [ "{{baseUrl}}" ], "path": [ "partnerships" ], "query": [ { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "All partnerships in one response. `nextCursor` exists in the contract for when it paginates — follow it from day one.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships", "host": [ "{{baseUrl}}" ], "path": [ "partnerships" ], "query": [ { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "All partnerships in one response. `nextCursor` exists in the contract for when it paginates — follow it from day one.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships", "host": [ "{{baseUrl}}" ], "path": [ "partnerships" ], "query": [ { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "All partnerships in one response. `nextCursor` exists in the contract for when it paginates — follow it from day one.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships", "host": [ "{{baseUrl}}" ], "path": [ "partnerships" ], "query": [ { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "504 · upstream_timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "All partnerships in one response. `nextCursor` exists in the contract for when it paginates — follow it from day one.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships", "host": [ "{{baseUrl}}" ], "path": [ "partnerships" ], "query": [ { "key": "status", "value": "", "description": "Stage.", "disabled": true }, { "key": "updatedSince", "value": "", "description": "Only what changed since this date/time (ISO 8601, UTC).", "disabled": true } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-timeout\",\n \"title\": \"The query took too long — try a smaller page\",\n \"status\": 504,\n \"code\": \"upstream_timeout\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "One partnership", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership, with both sides and who can move the funnel.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId" ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership, with both sides and who can move the funnel.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId" ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"pship-5b8d2f1e9a3c\",\n \"status\": \"NEGOTIATING\",\n \"kind\": \"PROPERTY_FOR_CLIENT\",\n \"propertyId\": \"prop-9e8d7c6b5a4f\",\n \"leadId\": \"lead-7c2e9a1b3d5f\",\n \"matchId\": \"m#prop-9e8d7c6b5a4f#lead-7c2e9a1b3d5f#L\",\n \"developmentId\": null,\n \"developmentTitle\": null,\n \"score\": 82,\n \"summary\": \"Apartamento 3 quartos no Batel para Carlos Pereira\",\n \"reasons\": [\n \"Bairro aceitável\"\n ],\n \"message\": \"Tenho um cliente para este imóvel.\",\n \"ourSide\": \"REQUESTER\",\n \"ourBrokerId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"canMoveFunnel\": true,\n \"requester\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\",\n \"type\": \"CORRETOR\"\n },\n \"addressee\": {\n \"accountId\": \"c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f\",\n \"name\": \"Rafael Lima\",\n \"type\": \"CORRETOR\"\n },\n \"counterpart\": {\n \"name\": \"Rafael Lima\",\n \"type\": \"CORRETOR\",\n \"organization\": \"Lima Imóveis\",\n \"contactName\": \"Rafael Lima\",\n \"phone\": \"41988887777\",\n \"email\": \"rafael@example.com\",\n \"creci\": \"F-12345/PR\",\n \"creciVerified\": true\n },\n \"property\": {\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purpose\": \"VENDA\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"price\": 890000,\n \"priceFrom\": false,\n \"rentPrice\": null,\n \"city\": \"Curitiba\",\n \"neighborhood\": \"Bigorrilho\",\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"listingUrl\": null,\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50,\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"deliveryDate\": null,\n \"developmentId\": null,\n \"developmentName\": null\n },\n \"client\": {\n \"masked\": false,\n \"status\": \"ATTENDING\",\n \"preApproved\": false,\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"regions\": [\n \"Bigorrilho, Curitiba\"\n ],\n \"priceMin\": 600000,\n \"priceMax\": 950000,\n \"bedrooms\": 3,\n \"parkingSpots\": 2,\n \"areaMin\": 80,\n \"name\": \"Carlos Pereira\"\n },\n \"lastProgressAt\": \"2026-10-02T16:45:12.000Z\",\n \"protectedUntil\": null,\n \"propertyOffMarketAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership, with both sides and who can move the funnel.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId" ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership, with both sides and who can move the funnel.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId" ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership, with both sides and who can move the funnel.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId" ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The partnership, with both sides and who can move the funnel.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId" ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Move the partnership stage", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"pship-5b8d2f1e9a3c\",\n \"status\": \"PROPOSAL\",\n \"kind\": \"PROPERTY_FOR_CLIENT\",\n \"propertyId\": \"prop-9e8d7c6b5a4f\",\n \"leadId\": \"lead-7c2e9a1b3d5f\",\n \"matchId\": \"m#prop-9e8d7c6b5a4f#lead-7c2e9a1b3d5f#L\",\n \"developmentId\": null,\n \"developmentTitle\": null,\n \"score\": 82,\n \"summary\": \"Apartamento 3 quartos no Batel para Carlos Pereira\",\n \"reasons\": [\n \"Bairro aceitável\"\n ],\n \"message\": \"Tenho um cliente para este imóvel.\",\n \"ourSide\": \"REQUESTER\",\n \"ourBrokerId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"canMoveFunnel\": true,\n \"requester\": {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\",\n \"type\": \"CORRETOR\"\n },\n \"addressee\": {\n \"accountId\": \"c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f\",\n \"name\": \"Rafael Lima\",\n \"type\": \"CORRETOR\"\n },\n \"counterpart\": {\n \"name\": \"Rafael Lima\",\n \"type\": \"CORRETOR\",\n \"organization\": \"Lima Imóveis\",\n \"contactName\": \"Rafael Lima\",\n \"phone\": \"41988887777\",\n \"email\": \"rafael@example.com\",\n \"creci\": \"F-12345/PR\",\n \"creciVerified\": true\n },\n \"property\": {\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purpose\": \"VENDA\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"price\": 890000,\n \"priceFrom\": false,\n \"rentPrice\": null,\n \"city\": \"Curitiba\",\n \"neighborhood\": \"Bigorrilho\",\n \"bedrooms\": 3,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/x/1/orig.jpg\",\n \"listingUrl\": null,\n \"commissionPercent\": 6,\n \"rentCommissionMonths\": null,\n \"splitListingPercent\": 50,\n \"lastConfirmedAt\": \"2026-10-02T16:45:12.000Z\",\n \"deliveryDate\": null,\n \"developmentId\": null,\n \"developmentName\": null\n },\n \"client\": {\n \"masked\": false,\n \"status\": \"ATTENDING\",\n \"preApproved\": false,\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"regions\": [\n \"Bigorrilho, Curitiba\"\n ],\n \"priceMin\": 600000,\n \"priceMax\": 950000,\n \"bedrooms\": 3,\n \"parkingSpots\": 2,\n \"areaMin\": 80,\n \"name\": \"Carlos Pereira\"\n },\n \"lastProgressAt\": \"2026-10-02T16:45:12.000Z\",\n \"protectedUntil\": null,\n \"propertyOffMarketAt\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"APPLIED\",\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Only the side that brought the client moves the funnel (`canMoveFunnel`). The other side can only close it after asking for an update and waiting 15 days without an answer — the dashboard rule.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/partnerships/:partnershipId/status?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "partnerships", ":partnershipId", "status" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "partnershipId", "value": "pship-5b8d2f1e9a3c", "description": "Partnership id (`pship-…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"PROPOSAL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Team", "description": "Who is on the team: name, e-mail, role and broker license. Your system matches the broker by e-mail.", "item": [ { "name": "The team", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Who is on the team, including suspended members.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/team", "host": [ "{{baseUrl}}" ], "path": [ "team" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Who is on the team, including suspended members.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/team", "host": [ "{{baseUrl}}" ], "path": [ "team" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"accountId\": \"9a7b6c5d-4e3f-4a1b-8c2d-1e0f9a8b7c6d\",\n \"name\": \"Marina Souza\",\n \"email\": \"marina@suaimobiliaria.com.br\",\n \"phone\": \"41977776666\",\n \"photoUrl\": null,\n \"creci\": \"F-54321/PR\",\n \"creciVerified\": true,\n \"status\": \"active\",\n \"canCaptureProperties\": true,\n \"isSupervisor\": false,\n \"supervisorId\": null,\n \"receivesLeadDistribution\": true,\n \"firstAccessAt\": \"2026-10-01T13:20:00.000Z\"\n }\n ],\n \"nextCursor\": null\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Who is on the team, including suspended members.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/team", "host": [ "{{baseUrl}}" ], "path": [ "team" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · not_available", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Who is on the team, including suspended members.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/team", "host": [ "{{baseUrl}}" ], "path": [ "team" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-available\",\n \"title\": \"Resource not available for this account type\",\n \"status\": 403,\n \"code\": \"not_available\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Who is on the team, including suspended members.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/team", "host": [ "{{baseUrl}}" ], "path": [ "team" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Who is on the team, including suspended members.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/team", "host": [ "{{baseUrl}}" ], "path": [ "team" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Launches", "description": "The city's new-development catalog: development, unit types, price list and construction stage.", "item": [ { "name": "The city's new developments", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"prop-1a2b3c4d5e6f\",\n \"title\": \"Residencial Jardim das Araucárias\",\n \"developer\": \"Construtora Exemplo\",\n \"address\": {\n \"neighborhood\": \"Mossunguê\",\n \"neighborhoodSlug\": \"mossungue\",\n \"city\": \"Curitiba\",\n \"cityId\": \"4106902\",\n \"citySlug\": \"curitiba\",\n \"state\": \"PR\"\n },\n \"constructionStage\": \"OFF_PLAN\",\n \"deliveryDate\": \"2028-06\",\n \"constructionProgress\": 35,\n \"coverPhoto\": \"https://cdn.imobyflow.com.br/properties/y/1/orig.jpg\",\n \"amenities\": [\n \"Piscina\"\n ],\n \"commissionPercent\": 5,\n \"priceMin\": 650000,\n \"priceMax\": 1200000,\n \"typologyCount\": 1,\n \"typologies\": [\n {\n \"id\": \"prop-6f5e4d3c2b1a\",\n \"title\": \"Garden 3 quartos\",\n \"type\": \"APARTAMENTO\",\n \"status\": \"ACTIVE\",\n \"salePrice\": 650000,\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 88,\n \"privateArea\": 84,\n \"coverPhoto\": null,\n \"floorPlans\": [],\n \"unitFeatures\": [\n \"Sacada com churrasqueira\"\n ],\n \"unitsAvailable\": 12,\n \"unitsTotal\": 40\n }\n ]\n }\n ],\n \"nextCursor\": \"eyJhIjoiNWMxZS4uLiJ9\"\n}" }, { "name": "400 · invalid_cursor", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-cursor\",\n \"title\": \"Invalid cursor — restart the listing without it\",\n \"status\": 400,\n \"code\": \"invalid_cursor\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "503 · upstream_busy", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-busy\",\n \"title\": \"Too many concurrent requests — retry shortly\",\n \"status\": 503,\n \"code\": \"upstream_busy\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "504 · upstream_timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The new-development catalog, with unit types.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/launches", "host": [ "{{baseUrl}}" ], "path": [ "launches" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 50 (default 20).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "citySlug", "value": "", "description": "City identifier in the catalog.", "disabled": true }, { "key": "neighborhood", "value": "", "description": "Neighborhood (name).", "disabled": true }, { "key": "type", "value": "", "description": "Subtype.", "disabled": true }, { "key": "stage", "value": "", "description": "Construction stage.", "disabled": true }, { "key": "priceMin", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "priceMax", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "q", "value": "", "description": "Search in the name.", "disabled": true } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/upstream-timeout\",\n \"title\": \"The query took too long — try a smaller page\",\n \"status\": 504,\n \"code\": \"upstream_timeout\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Captação (owner leads)", "description": "Property owners offered to the account and the acceptance, which debits credit and reveals the contact. Accepting requires its own permission and the specific term accepted in the dashboard.", "item": [ { "name": "Owners offered to the account", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The owners offered to the account right now, with the deadline running — the same cards as the desk — plus a summary (credit, pause, module status). Before accepting, contact and address do not exist in the response.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The owners offered to the account right now, with the deadline running — the same cards as the desk — plus a summary (credit, pause, module status). Before accepting, contact and address do not exist in the response.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"cap-8e7d6c5b4a39\",\n \"status\": \"OFFERED\",\n \"purpose\": \"VENDA\",\n \"propertyType\": \"CASA_RUA\",\n \"city\": \"Curitiba\",\n \"citySlug\": \"curitiba\",\n \"neighborhood\": \"Água Verde\",\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"usableAreaDeclared\": 140,\n \"areaDeclared\": 300,\n \"priceExpected\": 980000,\n \"sellTimeframe\": \"TRES_MESES\",\n \"occupancy\": \"VAZIO\",\n \"ownerRelation\": \"DONO\",\n \"exclusivityOpenness\": \"SIM\",\n \"alreadyListedDeclared\": false,\n \"priceCents\": 8000,\n \"deadline\": \"2026-10-03T17:00:00.000Z\",\n \"matchingClients\": {\n \"city\": 14,\n \"neighborhood\": 3\n },\n \"demand\": null,\n \"stockNeighborhood\": 22,\n \"ownerNameMasked\": \"Jo** S****\",\n \"ownerPhoneVerifiedVia\": \"WHATSAPP\",\n \"ownerPhoneVerifiedAt\": \"2026-10-01T13:20:00.000Z\",\n \"revealed\": false,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\"\n }\n ],\n \"summary\": {\n \"pendingCount\": 1,\n \"balanceCents\": 40000,\n \"subscriptionActive\": true,\n \"platformActive\": true,\n \"paused\": false,\n \"pausedAuto\": false,\n \"expiredStreak\": 0,\n \"autoPauseAfter\": 3,\n \"inActivation\": false,\n \"leadsToFirstCharge\": null,\n \"rechargePending\": false,\n \"operatingCities\": [\n \"curitiba\"\n ],\n \"purposes\": [\n \"VENDA\"\n ],\n \"serviceDays\": [\n \"MON\",\n \"TUE\",\n \"WED\",\n \"THU\",\n \"FRI\"\n ]\n },\n \"nextCursor\": null\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The owners offered to the account right now, with the deadline running — the same cards as the desk — plus a summary (credit, pause, module status). Before accepting, contact and address do not exist in the response.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · not_available", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The owners offered to the account right now, with the deadline running — the same cards as the desk — plus a summary (credit, pause, module status). Before accepting, contact and address do not exist in the response.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-available\",\n \"title\": \"Resource not available for this account type\",\n \"status\": 403,\n \"code\": \"not_available\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The owners offered to the account right now, with the deadline running — the same cards as the desk — plus a summary (credit, pause, module status). Before accepting, contact and address do not exist in the response.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · captacao_not_active", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The owners offered to the account right now, with the deadline running — the same cards as the desk — plus a summary (credit, pause, module status). Before accepting, contact and address do not exist in the response.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/captacao-not-active\",\n \"title\": \"Captação is not active for this account\",\n \"status\": 409,\n \"code\": \"captacao_not_active\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The owners offered to the account right now, with the deadline running — the same cards as the desk — plus a summary (credit, pause, module status). Before accepting, contact and address do not exist in the response.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "One owner", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Offered to the account (no contact) or already accepted by it (with contact).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId" ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Offered to the account (no contact) or already accepted by it (with contact).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId" ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"cap-8e7d6c5b4a39\",\n \"status\": \"OFFERED\",\n \"purpose\": \"VENDA\",\n \"propertyType\": \"CASA_RUA\",\n \"city\": \"Curitiba\",\n \"citySlug\": \"curitiba\",\n \"neighborhood\": \"Água Verde\",\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"usableAreaDeclared\": 140,\n \"areaDeclared\": 300,\n \"priceExpected\": 980000,\n \"sellTimeframe\": \"TRES_MESES\",\n \"occupancy\": \"VAZIO\",\n \"ownerRelation\": \"DONO\",\n \"exclusivityOpenness\": \"SIM\",\n \"alreadyListedDeclared\": false,\n \"priceCents\": 8000,\n \"deadline\": \"2026-10-03T17:00:00.000Z\",\n \"matchingClients\": {\n \"city\": 14,\n \"neighborhood\": 3\n },\n \"demand\": null,\n \"stockNeighborhood\": 22,\n \"ownerNameMasked\": \"Jo** S****\",\n \"ownerPhoneVerifiedVia\": \"WHATSAPP\",\n \"ownerPhoneVerifiedAt\": \"2026-10-01T13:20:00.000Z\",\n \"revealed\": false,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\"\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Offered to the account (no contact) or already accepted by it (with contact).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId" ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Offered to the account (no contact) or already accepted by it (with contact).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId" ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Offered to the account (no contact) or already accepted by it (with contact).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId" ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · captacao_not_active", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Offered to the account (no contact) or already accepted by it (with contact).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId" ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/captacao-not-active\",\n \"title\": \"Captação is not active for this account\",\n \"status\": 409,\n \"code\": \"captacao_not_active\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Offered to the account (no contact) or already accepted by it (with contact).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId" ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Accepted owners", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Accepted owners, by desk tab, in pages of 10, with the count of the three tabs.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/owners", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "owners" ], "query": [ { "key": "tab", "value": "", "description": "The tab (default `ACTIVE`).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Accepted owners, by desk tab, in pages of 10, with the count of the three tabs.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/owners", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "owners" ], "query": [ { "key": "tab", "value": "", "description": "The tab (default `ACTIVE`).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [],\n \"nextCursor\": null,\n \"total\": 0,\n \"counts\": {\n \"ACTIVE\": 0,\n \"CAPTURED\": 0,\n \"ARCHIVED\": 0\n }\n}" }, { "name": "400 · invalid_cursor", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Accepted owners, by desk tab, in pages of 10, with the count of the three tabs.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/owners", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "owners" ], "query": [ { "key": "tab", "value": "", "description": "The tab (default `ACTIVE`).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-cursor\",\n \"title\": \"Invalid cursor — restart the listing without it\",\n \"status\": 400,\n \"code\": \"invalid_cursor\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Accepted owners, by desk tab, in pages of 10, with the count of the three tabs.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/owners", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "owners" ], "query": [ { "key": "tab", "value": "", "description": "The tab (default `ACTIVE`).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Accepted owners, by desk tab, in pages of 10, with the count of the three tabs.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/owners", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "owners" ], "query": [ { "key": "tab", "value": "", "description": "The tab (default `ACTIVE`).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Accepted owners, by desk tab, in pages of 10, with the count of the three tabs.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/owners", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "owners" ], "query": [ { "key": "tab", "value": "", "description": "The tab (default `ACTIVE`).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · captacao_not_active", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Accepted owners, by desk tab, in pages of 10, with the count of the three tabs.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/owners", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "owners" ], "query": [ { "key": "tab", "value": "", "description": "The tab (default `ACTIVE`).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/captacao-not-active\",\n \"title\": \"Captação is not active for this account\",\n \"status\": 409,\n \"code\": \"captacao_not_active\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Accepted owners, by desk tab, in pages of 10, with the count of the three tabs.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/owners", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "owners" ], "query": [ { "key": "tab", "value": "", "description": "The tab (default `ACTIVE`).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Accept an owner", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"cap-8e7d6c5b4a39\",\n \"status\": \"OFFERED\",\n \"purpose\": \"VENDA\",\n \"propertyType\": \"CASA_RUA\",\n \"city\": \"Curitiba\",\n \"citySlug\": \"curitiba\",\n \"neighborhood\": \"Água Verde\",\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"usableAreaDeclared\": 140,\n \"areaDeclared\": 300,\n \"priceExpected\": 980000,\n \"sellTimeframe\": \"TRES_MESES\",\n \"occupancy\": \"VAZIO\",\n \"ownerRelation\": \"DONO\",\n \"exclusivityOpenness\": \"SIM\",\n \"alreadyListedDeclared\": false,\n \"priceCents\": 8000,\n \"deadline\": \"2026-10-03T17:00:00.000Z\",\n \"matchingClients\": {\n \"city\": 14,\n \"neighborhood\": 3\n },\n \"demand\": null,\n \"stockNeighborhood\": 22,\n \"ownerNameMasked\": \"Jo** S****\",\n \"ownerPhoneVerifiedVia\": \"WHATSAPP\",\n \"ownerPhoneVerifiedAt\": \"2026-10-01T13:20:00.000Z\",\n \"revealed\": false,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\"\n },\n \"result\": {\n \"outcome\": \"WOULD_ACCEPT\",\n \"dryRun\": true,\n \"priceCents\": 8000\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · captacao_terms_required", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/captacao-terms-required\",\n \"title\": \"Accepting via the API requires the specific term accepted in the dashboard\",\n \"status\": 403,\n \"code\": \"captacao_terms_required\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · captacao_insufficient_credit", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/captacao-insufficient-credit\",\n \"title\": \"Not enough Captação credit\",\n \"status\": 409,\n \"code\": \"captacao_insufficient_credit\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · captacao_not_active", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/captacao-not-active\",\n \"title\": \"Captação is not active for this account\",\n \"status\": 409,\n \"code\": \"captacao_not_active\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · offer_unavailable", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/offer-unavailable\",\n \"title\": \"This owner is no longer available to your account\",\n \"status\": 409,\n \"code\": \"offer_unavailable\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · request_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/request-refused\",\n \"title\": \"The platform refused the request\",\n \"status\": 422,\n \"code\": \"request_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "The only API path that spends money: it debits credit and reveals the contact. Requires the `captacao:accept` permission and item 13 of the API Terms accepted by the owner in the dashboard. Each acceptance records the key, the IP and the terms version. A dry run returns `WOULD_ACCEPT` with the price; retrying the same acceptance returns `ALREADY_ACCEPTED`, with no second debit.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/captacao/offers/:offerId/accept?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "captacao", "offers", ":offerId", "accept" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ], "variable": [ { "key": "offerId", "value": "cap-8e7d6c5b4a39", "description": "The owner's id on the desk (`cap-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Events", "description": "What changed in the account, in order, with 30 days of history — incremental sync. Events are lean: ids and the names of the changed fields; the detail comes from reading the resource.", "item": [ { "name": "What changed", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's events in order, with 30 days of history. Keep `nextCursor` and send it back next time — it always comes, even when there is nothing new. Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 500 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "since", "value": "", "description": "Start from this date/time (only without a cursor).", "disabled": true }, { "key": "types", "value": "", "description": "Only these types, comma-separated.", "disabled": true } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's events in order, with 30 days of history. Keep `nextCursor` and send it back next time — it always comes, even when there is nothing new. Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 500 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "since", "value": "", "description": "Start from this date/time (only without a cursor).", "disabled": true }, { "key": "types", "value": "", "description": "Only these types, comma-separated.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"evt_4f1c9a7e2b3d8c6a5e4f1b2c\",\n \"type\": \"property.updated\",\n \"createdAt\": \"2026-10-02T16:45:12.000Z\",\n \"data\": {\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"externalRef\": \"AP1234\",\n \"status\": \"ACTIVE\",\n \"changedFields\": [\n \"salePrice\"\n ],\n \"updatedAt\": \"2026-10-02T16:45:12.000Z\"\n }\n }\n ],\n \"nextCursor\": \"eyJhIjoiNWMxZS4uLiJ9\",\n \"hasMore\": false\n}" }, { "name": "400 · invalid_cursor", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's events in order, with 30 days of history. Keep `nextCursor` and send it back next time — it always comes, even when there is nothing new. Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 500 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "since", "value": "", "description": "Start from this date/time (only without a cursor).", "disabled": true }, { "key": "types", "value": "", "description": "Only these types, comma-separated.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-cursor\",\n \"title\": \"Invalid cursor — restart the listing without it\",\n \"status\": 400,\n \"code\": \"invalid_cursor\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's events in order, with 30 days of history. Keep `nextCursor` and send it back next time — it always comes, even when there is nothing new. Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 500 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "since", "value": "", "description": "Start from this date/time (only without a cursor).", "disabled": true }, { "key": "types", "value": "", "description": "Only these types, comma-separated.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's events in order, with 30 days of history. Keep `nextCursor` and send it back next time — it always comes, even when there is nothing new. Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 500 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "since", "value": "", "description": "Start from this date/time (only without a cursor).", "disabled": true }, { "key": "types", "value": "", "description": "Only these types, comma-separated.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's events in order, with 30 days of history. Keep `nextCursor` and send it back next time — it always comes, even when there is nothing new. Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 500 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "since", "value": "", "description": "Start from this date/time (only without a cursor).", "disabled": true }, { "key": "types", "value": "", "description": "Only these types, comma-separated.", "disabled": true } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's events in order, with 30 days of history. Keep `nextCursor` and send it back next time — it always comes, even when there is nothing new. Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 500 (default 100).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true }, { "key": "since", "value": "", "description": "Start from this date/time (only without a cursor).", "disabled": true }, { "key": "types", "value": "", "description": "Only these types, comma-separated.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Webhooks", "description": "The endpoints that receive events right away, signed with the Standard Webhooks spec, with retries, automatic disabling, redelivery and a test event.", "item": [ { "name": "Registered endpoints", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's webhook endpoints.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's webhook endpoints.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"wh_9c8b7a6f5e4d3c2b\",\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [],\n \"description\": \"CRM — produção\",\n \"status\": \"ACTIVE\",\n \"disabledAt\": null,\n \"disabledReason\": null,\n \"secretRotatedAt\": null,\n \"previousSecretValidUntil\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-01T13:20:00.000Z\"\n }\n ]\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's webhook endpoints.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's webhook endpoints.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The account's webhook endpoints.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Register an endpoint", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 · Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"wh_9c8b7a6f5e4d3c2b\",\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [],\n \"description\": \"CRM — produção\",\n \"status\": \"ACTIVE\",\n \"disabledAt\": null,\n \"disabledReason\": null,\n \"secretRotatedAt\": null,\n \"previousSecretValidUntil\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-01T13:20:00.000Z\"\n },\n \"secret\": \"whsec_pcwwPI/A9TWaDe9mPSrOkWlrkADDKDKjCKivhG986jw=\"\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · webhook_limit_reached", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/webhook-limit-reached\",\n \"title\": \"Account webhook limit reached\",\n \"status\": 409,\n \"code\": \"webhook_limit_reached\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · webhook_url_refused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/webhook-url-refused\",\n \"title\": \"Webhook URL refused\",\n \"status\": 422,\n \"code\": \"webhook_url_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "description": "HTTPS and public hosts only. The response carries the `secret` (`whsec_…`) ONCE — keep it: it is what you verify the signature with. This route does not accept `Idempotency-Key` (a stored response would keep the secret in plain text); repeating creates another endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [\n \"property.updated\",\n \"lead.created\"\n ],\n \"description\": \"CRM — produção\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Update an endpoint", "request": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"wh_9c8b7a6f5e4d3c2b\",\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [],\n \"description\": \"CRM — produção\",\n \"status\": \"ACTIVE\",\n \"disabledAt\": null,\n \"disabledReason\": null,\n \"secretRotatedAt\": null,\n \"previousSecretValidUntil\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-01T13:20:00.000Z\"\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · webhook_url_refused", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/webhook-url-refused\",\n \"title\": \"Webhook URL refused\",\n \"status\": 422,\n \"code\": \"webhook_url_refused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Changes the URL, the types, the description — or disables and re-enables it (re-enabling clears the disable reason).\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Delete an endpoint", "request": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"wh_9c8b7a6f5e4d3c2b\",\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [],\n \"description\": \"CRM — produção\",\n \"status\": \"ACTIVE\",\n \"disabledAt\": null,\n \"disabledReason\": null,\n \"secretRotatedAt\": null,\n \"previousSecretValidUntil\": null,\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-01T13:20:00.000Z\"\n },\n \"result\": {\n \"outcome\": \"DELETED\"\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Stops delivering and deletes the endpoint.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Rotate the secret", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Generates a new secret, returned ONCE. The previous one keeps signing alongside for 24 hours — time to switch it in your system without losing events. No `Idempotency-Key`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "rotate-secret" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Generates a new secret, returned ONCE. The previous one keeps signing alongside for 24 hours — time to switch it in your system without losing events. No `Idempotency-Key`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "rotate-secret" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"wh_9c8b7a6f5e4d3c2b\",\n \"url\": \"https://crm.suaimobiliaria.com.br/imobyflow/eventos\",\n \"types\": [],\n \"description\": \"CRM — produção\",\n \"status\": \"ACTIVE\",\n \"disabledAt\": null,\n \"disabledReason\": null,\n \"secretRotatedAt\": \"2026-10-02T16:45:12.000Z\",\n \"previousSecretValidUntil\": \"2026-10-03T16:45:12.000Z\",\n \"createdAt\": \"2026-10-01T13:20:00.000Z\",\n \"updatedAt\": \"2026-10-01T13:20:00.000Z\"\n },\n \"secret\": \"whsec_Hlmukgg3JG2Rb/ZqcR1wkYp5iy3AxDefBzk+bBHF5HM=\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Generates a new secret, returned ONCE. The previous one keeps signing alongside for 24 hours — time to switch it in your system without losing events. No `Idempotency-Key`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "rotate-secret" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Generates a new secret, returned ONCE. The previous one keeps signing alongside for 24 hours — time to switch it in your system without losing events. No `Idempotency-Key`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "rotate-secret" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Generates a new secret, returned ONCE. The previous one keeps signing alongside for 24 hours — time to switch it in your system without losing events. No `Idempotency-Key`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "rotate-secret" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "Generates a new secret, returned ONCE. The previous one keeps signing alongside for 24 hours — time to switch it in your system without losing events. No `Idempotency-Key`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "rotate-secret" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Send a test event", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"delivered\": true,\n \"statusCode\": 200,\n \"error\": null,\n \"ms\": 406\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "Delivers a `webhook.test` NOW, signed, and returns what your system answered.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "test" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "An endpoint's deliveries", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The deliveries, newest first, with status, attempts and the last status code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 200 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The deliveries, newest first, with status, attempts and the last status code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 200 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c\",\n \"eventId\": \"evt_4f1c9a7e2b3d8c6a5e4f1b2c\",\n \"type\": \"property.updated\",\n \"status\": \"DELIVERED\",\n \"attempts\": 1,\n \"lastStatusCode\": 200,\n \"lastError\": null,\n \"lastAttemptAt\": \"2026-10-02T16:45:12.000Z\",\n \"nextAttemptAt\": null,\n \"deliveredAt\": \"2026-10-02T16:45:12.000Z\",\n \"createdAt\": \"2026-10-02T16:45:12.000Z\"\n }\n ],\n \"nextCursor\": null\n}" }, { "name": "400 · invalid_cursor", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The deliveries, newest first, with status, attempts and the last status code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 200 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-cursor\",\n \"title\": \"Invalid cursor — restart the listing without it\",\n \"status\": 400,\n \"code\": \"invalid_cursor\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The deliveries, newest first, with status, attempts and the last status code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 200 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The deliveries, newest first, with status, attempts and the last status code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 200 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The deliveries, newest first, with status, attempts and the last status code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 200 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The deliveries, newest first, with status, attempts and the last status code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 200 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The deliveries, newest first, with status, attempts and the last status code.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries" ], "query": [ { "key": "limit", "value": "", "description": "Items per page: 1 to 200 (default 50).", "disabled": true }, { "key": "cursor", "value": "", "description": "The `nextCursor` from the previous page. The list is over when it comes back null. It is only valid for this route and this account.", "disabled": true } ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Redeliver", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c\",\n \"eventId\": \"evt_4f1c9a7e2b3d8c6a5e4f1b2c\",\n \"type\": \"property.updated\",\n \"status\": \"PENDING\",\n \"attempts\": 0,\n \"lastStatusCode\": 200,\n \"lastError\": null,\n \"lastAttemptAt\": \"2026-10-02T16:45:12.000Z\",\n \"nextAttemptAt\": null,\n \"deliveredAt\": \"2026-10-02T16:45:12.000Z\",\n \"createdAt\": \"2026-10-02T16:45:12.000Z\"\n },\n \"result\": {\n \"outcome\": \"SCHEDULED\"\n }\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "description": "A new round of attempts for the same delivery — with the SAME `webhook-id`, so your system recognizes the repeat. One already scheduled returns `ALREADY_SCHEDULED`.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "webhookId", "value": "wh_9c8b7a6f5e4d3c2b", "description": "Endpoint id (`wh_…`)." }, { "key": "deliveryId", "value": "dlv_20261002164512000_evt_4f1c9a7e2b3d8c6a5e4f1b2c", "description": "Delivery id (`dlv_…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] }, { "name": "Batches", "description": "Up to 500 properties or clients in one call, processed at the platform pace, with the outcome of each item.", "item": [ { "name": "Batch of properties", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 · Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"b-4c1d9e2f7a3b8c6d\",\n \"type\": \"properties\",\n \"status\": \"QUEUED\",\n \"total\": 1,\n \"accepted\": 1,\n \"rejected\": 0,\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 properties and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"AP1234\",\n \"title\": \"Apartamento 3 quartos no Bigorrilho\",\n \"type\": \"APARTAMENTO\",\n \"purposes\": [\n \"VENDA\"\n ],\n \"salePrice\": 890000,\n \"address\": {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\",\n \"street\": \"Rua Padre Anchieta\",\n \"number\": \"1500\",\n \"complement\": \"Ap 82\"\n },\n \"bedrooms\": 3,\n \"suites\": 1,\n \"bathrooms\": 2,\n \"parkingSpots\": 2,\n \"area\": 98,\n \"photos\": [\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/1.jpg\",\n \"https://www.suaimobiliaria.com.br/fotos/AP1234/2.jpg\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Track the batch", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"b-4c1d9e2f7a3b8c6d\",\n \"type\": \"properties\",\n \"status\": \"DONE\",\n \"dryRun\": false,\n \"total\": 1,\n \"processed\": 1,\n \"counts\": {\n \"UPDATED\": 1\n },\n \"createdAt\": \"2026-10-02T16:45:12.000Z\",\n \"startedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\",\n \"results\": [\n {\n \"index\": 0,\n \"externalRef\": \"AP1234\",\n \"outcome\": \"UPDATED\",\n \"id\": \"prop-3f9a1c2b7d4e\",\n \"code\": null,\n \"detail\": null,\n \"invalidParams\": null,\n \"photos\": \"UNCHANGED\"\n }\n ]\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/properties/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "properties", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Batch of clients", "request": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "202 · Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"b-4c1d9e2f7a3b8c6d\",\n \"type\": \"leads\",\n \"status\": \"QUEUED\",\n \"total\": 1,\n \"accepted\": 1,\n \"rejected\": 0,\n \"dryRun\": false\n }\n}" }, { "name": "400 · invalid_body", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-body\",\n \"title\": \"Invalid body — send a JSON object\",\n \"status\": 400,\n \"code\": \"invalid_body\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_idempotency_key", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-idempotency-key\",\n \"title\": \"Invalid Idempotency-Key (up to 100 visible characters)\",\n \"status\": 400,\n \"code\": \"invalid_idempotency_key\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "400 · invalid_param", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/invalid-param\",\n \"title\": \"Invalid parameter\",\n \"status\": 400,\n \"code\": \"invalid_param\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "409 · idempotency_in_progress", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-in-progress\",\n \"title\": \"A request with this Idempotency-Key is still in progress\",\n \"status\": 409,\n \"code\": \"idempotency_in_progress\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "413 · payload_too_large", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Content Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/payload-too-large\",\n \"title\": \"Payload too large\",\n \"status\": 413,\n \"code\": \"payload_too_large\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "422 · idempotency_key_reused", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Content", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/idempotency-key-reused\",\n \"title\": \"Idempotency-Key already used with a different request\",\n \"status\": 422,\n \"code\": \"idempotency_key_reused\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Language", "value": "en" }, { "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" } ], "description": "Up to 500 clients and 4 MB in one call. Each item is the PUT by code (`externalRef` required) — same rules, same outcomes. A malformed item comes back `REJECTED` and does not block the others; the same code twice in a batch is refused. Answers 202 right away and processes at the platform pace (4 items per second): 500 items take 2 to 3 minutes.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch?dryRun=true", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch" ], "query": [ { "key": "dryRun", "value": "true", "description": "Dry run: nothing is written.", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"externalRef\": \"CLI-889\",\n \"name\": \"Carlos Pereira\",\n \"phones\": [\n {\n \"number\": \"(41) 99999-8888\",\n \"isWhatsApp\": true\n }\n ],\n \"email\": \"carlos@example.com\",\n \"status\": \"ATTENDING\",\n \"ownerEmail\": \"marina@suaimobiliaria.com.br\",\n \"interest\": {\n \"purposes\": [\n \"VENDA\"\n ],\n \"propertyTypes\": [\n \"APARTAMENTO\"\n ],\n \"locations\": [\n {\n \"cityId\": \"4106902\",\n \"neighborhoodSlug\": \"bigorrilho\"\n }\n ],\n \"salePriceMax\": 950000,\n \"bedrooms\": 3\n },\n \"lastActivityAt\": \"2026-10-02T15:00:00Z\",\n \"consentGiven\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] }, { "name": "Track the batch", "request": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "response": [ { "name": "200 · OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"b-4c1d9e2f7a3b8c6d\",\n \"type\": \"leads\",\n \"status\": \"DONE\",\n \"dryRun\": false,\n \"total\": 1,\n \"processed\": 1,\n \"counts\": {\n \"UPDATED\": 1\n },\n \"createdAt\": \"2026-10-02T16:45:12.000Z\",\n \"startedAt\": \"2026-10-02T16:45:12.000Z\",\n \"finishedAt\": \"2026-10-02T16:45:12.000Z\",\n \"results\": [\n {\n \"index\": 0,\n \"externalRef\": \"CLI-889\",\n \"outcome\": \"UPDATED\",\n \"id\": \"lead-7c2e9a1b3d5f\",\n \"code\": null,\n \"detail\": null,\n \"invalidParams\": null,\n \"photos\": null\n }\n ]\n }\n}" }, { "name": "401 · unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/unauthorized\",\n \"title\": \"Chave ausente, inválida, revogada ou vencida\",\n \"status\": 401,\n \"code\": \"unauthorized\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "403 · scope_missing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/scope-missing\",\n \"title\": \"The key lacks the permission for this route\",\n \"status\": 403,\n \"code\": \"scope_missing\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "404 · not_found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/not-found\",\n \"title\": \"Not found\",\n \"status\": 404,\n \"code\": \"not_found\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" }, { "name": "429 · rate_limited", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Language", "value": "en" } ], "description": "The status, counts and each item outcome, in request order. The batch is available for 7 days.\n\nhttps://imobyflow.com.br/en/developers", "url": { "raw": "{{baseUrl}}/leads/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "leads", "batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "b-4c1d9e2f7a3b8c6d", "description": "Batch id (`b-…`)." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json; charset=utf-8" }, { "key": "X-Request-Id", "value": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e" }, { "key": "Content-Language", "value": "en" } ], "cookie": [], "body": "{\n \"type\": \"https://imobyflow.com.br/desenvolvedores/erros/rate-limited\",\n \"title\": \"Limite de chamadas por segundo atingido\",\n \"status\": 429,\n \"code\": \"rate_limited\",\n \"requestId\": \"8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e\"\n}" } ] } ] } ] }