Changelog and versions
The current version is v1 (contract 1.0.0). Changes are announced here before they apply.
Versioning policy
- Adding does not break: new fields, events, routes and values can arrive at any time. Your system must tolerate fields it does not know.
- Anything that breaks an existing integration ships in a new version (
/v2). The previous version keeps working for at least 12 months after the notice, published here and e-mailed to the account owner. - Code values (
VENDA,ACTIVE, the subtypes) are the same as the platform's, with no translation layer.
What changed
- Fix:
PUT /v1/properties/{propertyId}/ownerno longer erases the PIX key, bank account and personal data when the owner gains or loses the CPF between two writes. Namesakes without a document no longer inherit each other's data. - The follow-up routes (
/contacts,/next-step,/temperature,/lost) return the client's name, phones, e-mail and notes only for keys withleads:read; without it, those fields come back empty, in the same shape. - A write with
Idempotency-Keythat ends in 504: the same key returns the same 504 instead of writing again. Check with a read before retrying with another key. - Scheduling the SAME visit again (client, property, day and time) answers
ALREADY_SCHEDULEDwith the existing visit. - Tickets:
nullon PATCH clears the description, the quote and the supplier; the dry run refuses an undone contract and shows the owner's pending approval, like the real write. NaN,Infinity, a list or object in a closed-value field and overly nested JSON answer 400 — it used to be 500.GET /v1/rent/contracts/{contractId}no longer creates the renter link.
- Fix:
- The CRM in the API (
crm:readandcrm:writepermissions): each client's and property's visits, offers and sales; the property's owner; and, to record, the contact with its answer, the next step, the temperature, the loss with its reason, scheduling, rescheduling, cancelling and logging the visit, the offer with its rounds and outcome. Every write has a dry run. - Rentals in the API (
rent:readandrent:writepermissions): contracts, months with the charge status, pending payouts and tickets — open, update, move and cancel. Nothing that moves money: marking as paid, paying out and settling stay in the dashboard. - The client gains
crm: the temperature, the next step, the last contact answer and the loss reason. - New
module_requirederror (403): a CRM or Rentals write on an account without that module on. - The new permissions are not added to existing keys: create a key with them in the dashboard.
- The CRM in the API (
- Dates with an offset (
2026-10-02T09:00:00-03:00,+00:00) are accepted and converted to UTC — inupdatedSince,sinceand body dates. They used to be refused with 400. Without an offset, they count as UTC. - Webhooks: changing an endpoint's
typesapplies to the next delivery — for up to 1 minute, events used to go out under the old filter. Manually resending a delivery goes through even outside the filter. - The per-second limit is approximate: exceeding it leaves refusals (429) for a few minutes, even at a low pace. The SDKs wait for the
Retry-Afterand retry up to 5 times on 429, on a budget separate from failures (maxRateLimitRetries); the MCP server retries once before returning the 429 to the agent. - Properties: with the feed auto-sync off, a property written through the API is not taken down for being missing from the feed — a manual sync used to archive it 36 h later. With the auto-sync on, the feed is the source and whatever is not in the XML leaves, as before.
- Dates with an offset (
- Error codes are all lowercase: the access ones, which came in UPPERCASE, are now
ip_not_allowed,suspended,plan_not_eligible… (the page of each one kept its URL). - A query parameter the route does not accept is 400
unknown_param, with the accepted list — it used to be silently ignored. GET /v1/matches: new ones honorlimitand paginate with the cursor; an archived one that lost relevance comes asARCHIVEDwithlostRelevance: true; a partner property comes without its website and commission.GET /v1/events: asking again right after the end returns an empty list and the same cursor (it used to be 500);sincein the future is 400. SDKs: the events "all pages" helper stops onhasMore: false.changedFieldsuses the GET names.- Clients: a trashed client's code answers 409
lead_in_trash— thePUTby code used to create another client. - Properties: the outcome says what happened to the listing (
UPDATEDonly when it changes; conflict only,CONFIRMED), and every dry run goes through the same refusals as the real write. - Cities and neighborhoods: the cursor only works on its route and account; a city without a neighborhood list answers 200 with
hasCatalog: false; a state that does not exist is 400. - Partnerships:
summaryandmessageonly withleads:read. Batch confirmation: the same property requested twice comes asDUPLICATE, out of the summary. Webhook:types: nullgoes back to all events. - The 405 carries
Allow; the IP block says which IP arrived and the blocked call does not count toward the quota; permissions come in English;launches:write, which had no route, left the catalog.
- Error codes are all lowercase: the access ones, which came in UPPERCASE, are now
GET /v1/leads/{leadId}/radar: why a client gets no recommendations — what is missing in the profile and in the market, with what to do.GET /v1/leads/{leadId}/favorites: the client's favorites and what the client answered through the link (❤️, ❌ and the note).FAVORITEDopportunities now carryfavorite, with the answer.- Property:
condoFee(monthly condominium fee) andlandArea(land area) on read and write — the same values the dashboard shows and the feed stores. - Fix: the client's
radar.eligibleis nowfalsewhen the client is Won or Lost — such a client gets no recommendations, even with a complete profile.
- Official SDKs in TypeScript, Python and PHP, generated from this contract: one method per route, pages walked for you, retries that never duplicate a write, and webhook signature verification.
- Response examples (success and errors) in the Postman collection and in the OpenAPI. The public Postman collection follows every release.
POST /v1/feed/sync: your system says the portfolio changed and ImobyFlow fetches the feed link right away, without waiting 6 hours;GET /v1/feedshows the result.- MCP server at
https://api.imobyflow.com.br/mcp: AI agents read and update the account with the same key. Every write runs as a dry run and is only saved after confirmation. - New "Integrate your CRM" page: the portal feed without code, the map from every VRSync field to the API, and a card per CRM (Kenlo, Vista, Jetimob, Imobzi, Superlógica and CV CRM).
1.0.0
- Developer portal in Portuguese and English, generated from the OpenAPI 3.1 contract.
- One page per error code — the URL in each error's
type. - Postman collection, OpenAPI in JSON and YAML, and
llms.txtfor AI assistants. - A "Try it" button on every route: calls the API from the browser with your key (real reads, writes always as a dry run) and explains every field of the response — annotated JSON.
- Signed webhooks (Standard Webhooks), with retries for about 21 hours, automatic disabling, redelivery and a test event.
- Events (
GET /v1/events): what changed in the account, in order, with 30 days of history. - E-mail notices: key expiring, monthly quota at 80% and 100%, webhook endpoint disabled.
- Batches of up to 500 properties or clients.
- Captação: the desk, accepted owners and acceptance, with its own permission and term.
- Actions: dismiss and restore opportunities, move partnerships and the trash with the shrink guard.
- Client writes (your system's code, linking by contact, consent) and property writes (photos by URL, dry run,
Idempotency-Key). - Reads: properties, clients, opportunities, partnerships, team and new developments.
- The foundation: per-account keys, account-by-account access,
GET /v1/me, reference lists and the city and neighborhood catalog.
- The foundation: per-account keys, account-by-account access,