CRM
O atendimento de cada cliente: contatos, próximo passo, temperatura, visitas, propostas, vendas e o proprietário de cada imóvel. Ler vale sempre; registrar exige o CRM ligado na conta.
- GET/v1/leads/{leadId}/visits— Visitas do cliente
- GET/v1/properties/{propertyId}/visits— Visitas do imóvel
- GET/v1/leads/{leadId}/proposals— Propostas do cliente
- GET/v1/properties/{propertyId}/proposals— Propostas do imóvel
- GET/v1/leads/{leadId}/sales— Vendas do cliente
- GET/v1/properties/{propertyId}/sales— Vendas do imóvel
- GET/v1/properties/{propertyId}/owner— Proprietário do imóvel
- PUT/v1/properties/{propertyId}/owner— Gravar o proprietário
- POST/v1/leads/{leadId}/contacts— Registrar como foi o contato
- POST/v1/leads/{leadId}/next-step— Marcar o próximo passo
- POST/v1/leads/{leadId}/temperature— Travar a temperatura
- POST/v1/leads/{leadId}/lost— Encerrar como perdido
- POST/v1/leads/{leadId}/visits— Agendar uma visita
- POST/v1/visits/{visitId}/reschedule— Remarcar a visita
- POST/v1/visits/{visitId}/cancel— Cancelar a visita
- POST/v1/visits/{visitId}/outcome— Registrar como foi a visita
- POST/v1/leads/{leadId}/proposals— Registrar uma proposta
- POST/v1/proposals/{proposalId}/rounds— Registrar uma contraproposta
- POST/v1/proposals/{proposalId}/close— Encerrar a proposta
As rotas
/v1/leads/{leadId}/visitsVisitas do cliente
As visitas do cliente, da mais nova para a mais antiga (até 200). Vale mesmo sem o CRM ligado: o que foi registrado continua legível.
crm:readParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Resposta200OK
datalista de Visitobrigatório- As visitas.
nextCursorstringobrigatóriopode vir nulo- Cursor da próxima página (nulo = acabou).
Exemplo
curl -X GET 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/visits' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR'Erros desta rota
/v1/properties/{propertyId}/visitsVisitas do imóvel
As visitas ao imóvel, de todos os clientes, da mais nova para a mais antiga. A visita de um comprador de parceiro vem sem a anotação do corretor dele.
crm:readParâmetros no caminho
propertyIdstringobrigatório- Id do imóvel (
prop-…).
Resposta200OK
datalista de Visitobrigatório- As visitas.
nextCursorstringobrigatóriopode vir nulo- Cursor da próxima página (nulo = acabou).
Exemplo
curl -X GET 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/visits' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR'Erros desta rota
/v1/leads/{leadId}/proposalsPropostas do cliente
As propostas do cliente, com as rodadas da negociação, da mais nova para a mais antiga.
crm:readParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Resposta200OK
datalista de Proposalobrigatório- As propostas.
nextCursorstringobrigatóriopode vir nulo- Cursor da próxima página (nulo = acabou).
Exemplo
curl -X GET 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/proposals' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR'Erros desta rota
/v1/properties/{propertyId}/proposalsPropostas do imóvel
As propostas recebidas pelo imóvel, de todos os clientes.
crm:readParâmetros no caminho
propertyIdstringobrigatório- Id do imóvel (
prop-…).
Resposta200OK
datalista de Proposalobrigatório- As propostas.
nextCursorstringobrigatóriopode vir nulo- Cursor da próxima página (nulo = acabou).
Exemplo
curl -X GET 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/proposals' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR'Erros desta rota
/v1/leads/{leadId}/salesVendas do cliente
As vendas e locações fechadas com o cliente, com a divisão da comissão. Só leitura: registrar uma venda é na tela.
crm:readParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Resposta200OK
datalista de Saleobrigatório- As vendas.
nextCursorstringobrigatóriopode vir nulo- Cursor da próxima página (nulo = acabou).
Exemplo
curl -X GET 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/sales' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR'Erros desta rota
/v1/properties/{propertyId}/salesVendas do imóvel
As vendas e locações fechadas do imóvel, com a divisão da comissão.
crm:readParâmetros no caminho
propertyIdstringobrigatório- Id do imóvel (
prop-…).
Resposta200OK
datalista de Saleobrigatório- As vendas.
nextCursorstringobrigatóriopode vir nulo- Cursor da próxima página (nulo = acabou).
Exemplo
curl -X GET 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/sales' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR'Erros desta rota
/v1/properties/{propertyId}/ownerProprietário do imóvel
Os proprietários e a autorização de venda: assinada quando, vale até quando, com exclusividade e a comissão combinada. Sem a chave PIX, a conta bancária e os dados pessoais completos.
crm:readParâmetros no caminho
propertyIdstringobrigatório- Id do imóvel (
prop-…).
Resposta200OK
dataPropertyOwnerCardobrigatório- O cartão.
Exemplo
curl -X GET 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/owner' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR'Erros desta rota
/v1/properties/{propertyId}/ownerGravar o proprietário
Substitui o cartão do proprietário: a lista de proprietários e a autorização. O que não vier fica vazio — menos a chave PIX, a conta bancária e os dados pessoais de cada proprietário, que a API não vê e mantém (achados pelo CPF/CNPJ ou, sem ele, pelo nome). Exige o CRM (ou a Locação) ligado.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
propertyIdstringobrigatório- Id do imóvel (
prop-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
ownerslista de OwnerPersonInputobrigatório- De 1 a 10 proprietários. Substitui a lista.
authSignedOnstring- Autorização assinada em (
2026-11-20). authValidUntilstring- Autorização válida até (
2027-05-20). exclusiveboolean- Com exclusividade.
commissionPercentnumber- A comissão combinada, em %.
Exemplo de corpo
{
"owners": [
{
"name": "João Almeida",
"phone": "41988887777",
"document": "12345678909",
"sharePercent": 100
}
],
"authSignedOn": "2026-10-01",
"authValidUntil": "2027-04-01",
"exclusive": true,
"commissionPercent": 6
}Resposta200OK201 quando cria o cartão.
dataPropertyOwnerCardobrigatório- O objeto como ficou.
resultCrmWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X PUT 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/owner?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"owners": [
{
"name": "João Almeida",
"phone": "41988887777",
"document": "12345678909",
"sharePercent": 100
}
],
"authSignedOn": "2026-10-01",
"authValidUntil": "2027-04-01",
"exclusive": true,
"commissionPercent": 6
}
JSONErros desta rota
/v1/leads/{leadId}/contactsRegistrar como foi o contato
O "Como foi o contato?" da tela num pedido: a resposta, a anotação e o próximo passo. A resposta acerta a temperatura (se ninguém a travou) e tira o cliente de Novo. GAVE_UP encerra como Perdido e exige lostReason. Substitui POST /leads/{leadId}/interactions com CONTACT para quem tem o CRM.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
outcomestringobrigatório- Como foi.um de
THINKINGFAMILYFINANCINGWANTS_VISITMORE_OPTIONSDISLIKEDNO_ANSWERGAVE_UP notestring- Anotação.
nextStepDuestring- Próximo passo: o dia (
2026-11-21) ou o dia e a hora (2026-11-21T14:30), no horário de São Paulo. Sem ele, o próximo passo sai. nextStepTitlestring- O que fazer no próximo passo.
lostReasonstring- Por que foi perdido (obrigatório com
GAVE_UP).um deBOUGHT_ELSEWHEREGAVE_UP_BUYINGCREDIT_DENIEDNOT_FOUNDSTOPPED_ANSWERINGOTHER lostNotestring- Anotação da perda.
Exemplo de corpo
{
"outcome": "WANTS_VISIT",
"note": "Quer ver o AP1234 no sábado.",
"nextStepDue": "2026-11-21T10:00",
"nextStepTitle": "Confirmar a visita"
}Resposta200OK
dataLeadobrigatório- O objeto como ficou.
resultLeadWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/contacts?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"outcome": "WANTS_VISIT",
"note": "Quer ver o AP1234 no sábado.",
"nextStepDue": "2026-11-21T10:00",
"nextStepTitle": "Confirmar a visita"
}
JSONErros desta rota
/v1/leads/{leadId}/next-stepMarcar o próximo passo
Marca ou troca o próximo passo, sem registrar contato. due: null tira. Um por cliente: o novo substitui o anterior.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
duestringobrigatóriopode vir nulo- O dia (
2026-11-21) ou o dia e a hora (2026-11-21T14:30), no horário de São Paulo — de hoje a um ano. titlestring- O que fazer (padrão: "Retomar o contato").
Exemplo de corpo
{
"due": "2026-11-24",
"title": "Mandar as opções no Bigorrilho"
}Resposta200OK
dataLeadobrigatório- O objeto como ficou.
resultLeadWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/next-step?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"due": "2026-11-24",
"title": "Mandar as opções no Bigorrilho"
}
JSONErros desta rota
/v1/leads/{leadId}/temperatureTravar a temperatura
Trava a temperatura à mão (HOT, WARM, COLD): as respostas dos contatos deixam de mudá-la. temperature: null devolve à automática.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
temperaturestringobrigatóriopode vir nulo- A temperatura.um de
HOTWARMCOLD
Exemplo de corpo
{
"temperature": "HOT"
}Resposta200OK
dataLeadobrigatório- O objeto como ficou.
resultLeadWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/temperature?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"temperature": "HOT"
}
JSONErros desta rota
/v1/leads/{leadId}/lostEncerrar como perdido
Leva o cliente para Perdido, com o motivo; o próximo passo sai junto. As parcerias abertas do cliente NÃO são encerradas pela API — a tela avisa a equipe.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
reasonstringobrigatório- O motivo.um de
BOUGHT_ELSEWHEREGAVE_UP_BUYINGCREDIT_DENIEDNOT_FOUNDSTOPPED_ANSWERINGOTHER notestring- Anotação.
Exemplo de corpo
{
"reason": "BOUGHT_ELSEWHERE",
"note": "Fechou com a construtora direto."
}Resposta200OK
dataLeadobrigatório- O objeto como ficou.
resultLeadWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/lost?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"reason": "BOUGHT_ELSEWHERE",
"note": "Fechou com a construtora direto."
}
JSONErros desta rota
/v1/leads/{leadId}/visitsAgendar uma visita
Marca a visita do cliente a um imóvel da carteira (ou de um parceiro, com a parceria aberta). Ela vira o próximo passo, deixa o cliente Quente e aparece no Meu dia do corretor.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
propertyIdstringobrigatório- O imóvel.
scheduledAtstringobrigatório- Dia e hora, no horário de São Paulo (
2026-11-21T10:00) — de hoje a um ano. brokerAccountIdstring- Quem acompanha (padrão: o corretor do cliente). Tem de ser da equipe.
Exemplo de corpo
{
"propertyId": "prop-3f9a1c2b7d4e",
"scheduledAt": "2026-11-21T10:00"
}Resposta201Criado
dataVisitobrigatório- O objeto como ficou.
resultCrmWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/visits?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"propertyId": "prop-3f9a1c2b7d4e",
"scheduledAt": "2026-11-21T10:00"
}
JSONErros desta rota
/v1/visits/{visitId}/rescheduleRemarcar a visita
Muda o dia e a hora de uma visita marcada.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
visitIdstringobrigatório- Id da visita (
vis-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
scheduledAtstringobrigatório- Dia e hora, no horário de São Paulo (
2026-11-22T15:00).
Exemplo de corpo
{
"scheduledAt": "2026-11-22T15:00"
}Resposta200OK
dataVisitobrigatório- O objeto como ficou.
resultCrmWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/visits/visitId/reschedule?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"scheduledAt": "2026-11-22T15:00"
}
JSONErros desta rota
/v1/visits/{visitId}/cancelCancelar a visita
Cancela uma visita marcada; o cancelamento entra no histórico do cliente.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
visitIdstringobrigatório- Id da visita (
vis-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
notestring- O motivo.
Exemplo de corpo
{
"note": "O cliente viajou."
}Resposta200OK
dataVisitobrigatório- O objeto como ficou.
resultCrmWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/visits/visitId/cancel?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"note": "O cliente viajou."
}
JSONErros desta rota
/v1/visits/{visitId}/outcomeRegistrar como foi a visita
O "Como foi a visita?": feita (com a impressão do cliente) ou NO_SHOW. Acerta a temperatura e marca o próximo passo, como na tela.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
visitIdstringobrigatório- Id da visita (
vis-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
outcomestringobrigatório- Como foi.um de
WANTS_PROPOSALWANTS_RETURNTHINKINGDISLIKEDNO_SHOW notestring- Anotação.
nextStepDuestring- Próximo passo: o dia ou o dia e a hora, no horário de São Paulo.
nextStepTitlestring- O que fazer.
Exemplo de corpo
{
"outcome": "WANTS_PROPOSAL",
"note": "Gostou da vista. Quer oferecer 850 mil.",
"nextStepDue": "2026-11-22",
"nextStepTitle": "Montar a proposta"
}Resposta200OK
dataVisitobrigatório- O objeto como ficou.
resultCrmWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/visits/visitId/outcome?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"outcome": "WANTS_PROPOSAL",
"note": "Gostou da vista. Quer oferecer 850 mil.",
"nextStepDue": "2026-11-22",
"nextStepTitle": "Montar a proposta"
}
JSONErros desta rota
/v1/leads/{leadId}/proposalsRegistrar uma proposta
A proposta do cliente por um imóvel: compra (SALE, com formas de pagamento e entrada) ou aluguel (RENT, com garantia e prazo). No imóvel de venda E locação, kind é obrigatório. Leva o cliente para Proposta; no imóvel de parceiro, a imobiliária parceira é avisada, como na tela.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
leadIdstringobrigatório- Id do cliente (
lead-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
propertyIdstringobrigatório- O imóvel.
kindstringSALEouRENT.um deSALERENTamountnumberobrigatório- O valor oferecido (no aluguel, o aluguel por mês).
paymentMethodslista de string- Formas de pagamento (compra).um de
FINANCINGFGTSCASHEXCHANGECONSORTIUM downPaymentnumber- Entrada (compra) — não pode passar do valor.
validUntilstring- Vale até (
2026-11-30). conditionsstring- Condições.
rentGuaranteestring- Garantia (aluguel).um de
FIANCACAUCAOSEGURO_FIANCAGARANTIA_DIGITALTITULONENHUMA rentMonthsinteger- Prazo em meses (aluguel).
rentStartOnstring- Início desejado (aluguel).
nextStepDuestring- Próximo passo: o dia ou o dia e a hora.
nextStepTitlestring- O que fazer.
Exemplo de corpo
{
"propertyId": "prop-3f9a1c2b7d4e",
"kind": "SALE",
"amount": 850000,
"paymentMethods": [
"FINANCING",
"FGTS"
],
"downPayment": 170000,
"validUntil": "2026-11-30",
"conditions": "Escritura em 60 dias.",
"nextStepDue": "2026-11-25",
"nextStepTitle": "Cobrar a resposta"
}Resposta201Criado
dataProposalobrigatório- O objeto como ficou.
resultCrmWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/proposals?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"propertyId": "prop-3f9a1c2b7d4e",
"kind": "SALE",
"amount": 850000,
"paymentMethods": [
"FINANCING",
"FGTS"
],
"downPayment": 170000,
"validUntil": "2026-11-30",
"conditions": "Escritura em 60 dias.",
"nextStepDue": "2026-11-25",
"nextStepTitle": "Cobrar a resposta"
}
JSONErros desta rota
/v1/proposals/{proposalId}/roundsRegistrar uma contraproposta
Uma rodada nova na mesma proposta: de quem (CLIENT ou OWNER) e quanto. O valor da proposta passa a ser o dela.
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
proposalIdstringobrigatório- Id da proposta (
prp-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
bystringobrigatório- De quem.um de
CLIENTOWNER amountnumberobrigatório- O valor.
notestring- Anotação.
Exemplo de corpo
{
"by": "OWNER",
"amount": 875000,
"note": "Aceita 875 com escritura em 45 dias."
}Resposta200OK
dataProposalobrigatório- O objeto como ficou.
resultCrmWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/proposals/proposalId/rounds?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"by": "OWNER",
"amount": 875000,
"note": "Aceita 875 com escritura em 45 dias."
}
JSONErros desta rota
/v1/proposals/{proposalId}/closeEncerrar a proposta
O desfecho: ACCEPTED, REJECTED, WITHDRAWN ou EXPIRED. Fora a aceita, o cliente volta para Atendendo quando não há outra proposta aberta dele. Registrar a VENDA que vem da aceita é na tela (é ali que se divide a comissão).
crm:writeAceita modo ensaioAceita Idempotency-KeyParâmetros no caminho
proposalIdstringobrigatório- Id da proposta (
prp-…).
Filtros e paginação
dryRunbooleantrue= modo ensaio: valida e diz o que aconteceria, sem gravar nada.
Corpo do pedido
outcomestringobrigatório- O desfecho.um de
ACCEPTEDREJECTEDWITHDRAWNEXPIRED notestring- Anotação.
nextStepDuestring- Próximo passo: o dia ou o dia e a hora.
nextStepTitlestring- O que fazer.
Exemplo de corpo
{
"outcome": "ACCEPTED",
"note": "Fechado em 875 mil."
}Resposta200OK
dataProposalobrigatório- O objeto como ficou.
resultCrmWriteResultobrigatório- O desfecho.
Exemplo
# Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
curl -X POST 'https://api.imobyflow.com.br/v1/proposals/proposalId/close?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: pt-BR' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"outcome": "ACCEPTED",
"note": "Fechado em 875 mil."
}
JSONErros desta rota
Os objetos
CrmProperty
O imóvel, como estava quando o registro foi feito.
titlestringobrigatóriopode vir nulo- Título do anúncio.
typestringobrigatóriopode vir nulo- Subtipo.
neighborhoodstringobrigatóriopode vir nulo- Bairro.
citystringobrigatóriopode vir nulo- Cidade.
Visit
Uma visita do CRM.
idstringobrigatóriopode vir nulo- Id da visita (
vis-…). Nulo no ensaio de um agendamento. leadIdstringobrigatório- O cliente.
propertyIdstringobrigatório- O imóvel.
brokerAccountIdstringobrigatóriopode vir nulo- Quem acompanha a visita.
scheduledAtstringobrigatório- Dia e hora, no horário de São Paulo (
2026-11-21T10:00). statusstringobrigatórioSCHEDULED,DONE,NO_SHOWouCANCELLED.um deSCHEDULEDDONENO_SHOWCANCELLEDoutcomestringobrigatóriopode vir nulo- Como foi.um de
WANTS_PROPOSALWANTS_RETURNTHINKINGDISLIKEDNO_SHOW notestringobrigatóriopode vir nulo- Anotação do corretor.
propertyCrmPropertyobrigatório- O imóvel.
partnershipIdstringobrigatóriopode vir nulo- A parceria, quando o imóvel é de um parceiro.
slipSignedAtstringobrigatóriopode vir nulo- Quando o comprador assinou a ficha de visita. A ficha em si fica na tela.
doneAtstringobrigatóriopode vir nulo- Quando foi registrada como feita.
createdAtstringobrigatóriopode vir nulo- Quando foi criado (UTC).
updatedAtstringobrigatóriopode vir nulo- Última alteração (UTC).
ProposalRound
Uma rodada da negociação.
atstringobrigatório- Quando.
bystringobrigatórioCLIENT(o cliente ofereceu) ouOWNER(o proprietário contrapropôs).um deCLIENTOWNERamountnumberobrigatório- O valor da rodada.
notestringobrigatóriopode vir nulo- Anotação.
Proposal
Uma proposta do CRM.
idstringobrigatóriopode vir nulo- Id da proposta (
prp-…). Nulo no ensaio de uma criação. leadIdstringobrigatório- O cliente.
propertyIdstringobrigatório- O imóvel.
brokerAccountIdstringobrigatóriopode vir nulo- O corretor do cliente.
kindstringobrigatórioSALE(compra) ouRENT(aluguel).um deSALERENTstatusstringobrigatório- A situação.um de
OPENACCEPTEDREJECTEDWITHDRAWNEXPIREDSOLDFELL_THROUGHRENTED amountnumberobrigatório- O valor de agora (o da última rodada). No aluguel, o aluguel oferecido.
askingPricenumberobrigatóriopode vir nulo- O preço anunciado quando a proposta foi feita.
paymentMethodslista de stringobrigatório- Formas de pagamento (compra).um de
FINANCINGFGTSCASHEXCHANGECONSORTIUM downPaymentnumberobrigatóriopode vir nulo- Entrada (compra).
validUntilstringobrigatóriopode vir nulo- Vale até (dia).
conditionsstringobrigatóriopode vir nulo- Condições.
rentGuaranteestringobrigatóriopode vir nulo- Garantia (aluguel).um de
FIANCACAUCAOSEGURO_FIANCAGARANTIA_DIGITALTITULONENHUMA rentMonthsintegerobrigatóriopode vir nulo- Prazo em meses (aluguel).
rentStartOnstringobrigatóriopode vir nulo- Início desejado (aluguel).
roundslista de ProposalRoundobrigatório- As rodadas, da primeira à última.
propertyCrmPropertyobrigatório- O imóvel.
partnershipIdstringobrigatóriopode vir nulo- A parceria, quando o imóvel é de um parceiro.
acceptedAtstringobrigatóriopode vir nulo- Quando foi aceita.
reservedUntilstringobrigatóriopode vir nulo- Reservado até (dia), depois de aceita.
closeNotestringobrigatóriopode vir nulo- A anotação do desfecho.
closedAtstringobrigatóriopode vir nulo- Quando foi encerrada.
rentContractIdstringobrigatóriopode vir nulo- O contrato de aluguel que nasceu dela.
createdAtstringobrigatóriopode vir nulo- Quando foi criado (UTC).
updatedAtstringobrigatóriopode vir nulo- Última alteração (UTC).
SaleSplit
Uma parte da divisão da comissão.
accountIdstringobrigatório- Quem recebe.
namestringobrigatóriopode vir nulo- Nome.
roleslista de stringobrigatório- Os papéis na venda.
percentnumberobrigatóriopode vir nulo- O percentual da comissão.
valuenumberobrigatóriopode vir nulo- O valor.
Sale
Uma venda (ou locação) fechada no CRM. Só leitura pela API: a divisão da comissão é registrada na tela.
idstringobrigatório- Id da venda.
leadIdstringobrigatório- O cliente.
propertyIdstringobrigatório- O imóvel.
proposalIdstringobrigatóriopode vir nulo- A proposta aceita.
kindstringobrigatórioSALEouRENT.um deSALERENTstatusstringobrigatório- A situação da venda (desfeita =
UNDONE). closedOnstringobrigatóriopode vir nulo- O dia do fechamento.
amountnumberobrigatóriopode vir nulo- O valor.
askingPricenumberobrigatóriopode vir nulo- O preço anunciado.
paymentMethodslista de stringobrigatório- Formas de pagamento.
commissionPercentnumberobrigatóriopode vir nulo- O percentual da comissão.
commissionTotalnumberobrigatóriopode vir nulo- A comissão total.
splitslista de SaleSplitobrigatório- A divisão da comissão.
partialbooleanobrigatório- Só uma parte da divisão é desta conta (venda em parceria).
propertyMarkedSoldbooleanobrigatório- O imóvel saiu do ar como vendido ou alugado.
propertyCrmPropertyobrigatório- O imóvel.
createdAtstringobrigatóriopode vir nulo- Quando foi criado (UTC).
undoneAtstringobrigatóriopode vir nulo- Quando foi desfeita.
OwnerPerson
Um proprietário. Dado pessoal: a imobiliária é a controladora.
namestringobrigatóriopode vir nulo- Nome.
phonestringobrigatóriopode vir nulo- Telefone.
emailstringobrigatóriopode vir nulo- E-mail.
documentstringobrigatóriopode vir nulo- CPF ou CNPJ, formatado.
documentTypestringobrigatóriopode vir nuloCPFouCNPJ.sharePercentnumberobrigatóriopode vir nulo- A parte dele no imóvel, em %.
PropertyOwnerCard
O proprietário do imóvel e a autorização. A chave PIX, a conta bancária e os dados pessoais completos ficam na tela.
propertyIdstringobrigatório- O imóvel.
existsbooleanobrigatório- O cartão foi preenchido.
ownerslista de OwnerPersonobrigatório- Os proprietários.
authSignedOnstringobrigatóriopode vir nulo- Autorização de venda assinada em (dia).
authValidUntilstringobrigatóriopode vir nulo- Autorização válida até (dia).
authStatusstringobrigatóriopode vir nuloNONE,VALID,EXPIRING(vence em breve) ouEXPIRED.um deNONEVALIDEXPIRINGEXPIREDauthDaysLeftintegerobrigatóriopode vir nulo- Dias até a autorização vencer.
exclusivebooleanobrigatóriopode vir nulo- Com exclusividade.
commissionPercentnumberobrigatóriopode vir nulo- A comissão combinada com o proprietário, em %.
updatedAtstringobrigatóriopode vir nulo- Última alteração (UTC).
OwnerPersonInput
Um proprietário.
namestring- Nome. Obrigatório.
phonestring- Telefone.
emailstring- E-mail.
documentstring- CPF ou CNPJ.
sharePercentnumber- A parte dele, em %.
PropertyOwnerInput
O cartão inteiro. O que não vier fica vazio — menos a chave PIX, a conta bancária e os dados pessoais do proprietário, que a API não vê e não apaga.
ownerslista de OwnerPersonInputobrigatório- De 1 a 10 proprietários. Substitui a lista.
authSignedOnstring- Autorização assinada em (
2026-11-20). authValidUntilstring- Autorização válida até (
2027-05-20). exclusiveboolean- Com exclusividade.
commissionPercentnumber- A comissão combinada, em %.
CrmWriteResult
O desfecho da escrita.
outcomestringobrigatório- O que aconteceu:
RECORDED,UPDATED,CLEARED,CLOSED,SCHEDULED,ALREADY_SCHEDULED(a mesma visita já estava marcada — nada foi criado),RESCHEDULED,CANCELLED,CREATED,ROUND_ADDED,MOVED. dryRunbooleanobrigatório- Foi um ensaio — nada foi gravado e ninguém foi avisado.