Captação

Os proprietários que chegam à vez da conta e o aceite, que debita o crédito e libera o contato. Aceitar exige uma permissão própria e o termo específico aceito no painel.

GET/v1/captacao/offers— Proprietários na vez da conta
GET/v1/captacao/offers/{offerId}— Um proprietário
GET/v1/captacao/owners— Proprietários aceitos
POST/v1/captacao/offers/{offerId}/accept— Aceitar um proprietário

As rotas

GET/v1/captacao/offers

Proprietários na vez da conta

Os proprietários na vez da conta agora, com o prazo correndo — os mesmos cards da mesa —, e o resumo (crédito, pausa, módulo valendo). Antes do aceite, contato e endereço não existem na resposta.

Permissão: captacao:read

Resposta200OK

datalista de CaptacaoOfferobrigatório: Os proprietários.
summaryCaptacaoSummaryobrigatório: O resumo da mesa.
nextCursorstringobrigatóriopode vir nulo: Sempre nulo hoje.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/captacao/offers' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

GET/v1/captacao/offers/{offerId}

Um proprietário

Na vez da conta (sem contato) ou já aceito por ela (com contato).

Permissão: captacao:read

Parâmetros no caminho

offerIdstringobrigatório: Id do proprietário na mesa (cap-…).

Resposta200OK

dataCaptacaoOfferobrigatório: O proprietário.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/captacao/offers/cap-8e7d6c5b4a39' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

GET/v1/captacao/owners

Proprietários aceitos

Os aceitos, por aba da mesa, em páginas de 10, com a contagem das três abas.

Permissão: captacao:read

Filtros e paginação

tabstring: A aba (padrão ACTIVE).um de ACTIVE CAPTURED ARCHIVED
cursorstring: O nextCursor da página anterior. A lista acabou quando ele vem nulo. Ele vale só para esta rota e esta conta.

Resposta200OK

datalista de CaptacaoOfferobrigatório: Os aceitos.
nextCursorstringobrigatóriopode vir nulo: Próxima página.
totalintegerobrigatóriopode vir nulo: Total na aba.
countsmapaobrigatóriopode vir nulo: Quantos em cada aba.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/captacao/owners' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

POST/v1/captacao/offers/{offerId}/accept

O único caminho da API que gasta dinheiro: debita o crédito e libera o contato. Exige a permissão captacao:accept e o termo do item 13 dos Termos da API aceito pelo dono no painel. Cada aceite grava a chave, o IP e a versão do termo. Ensaio responde WOULD_ACCEPT com o preço; a re-tentativa do mesmo aceite, ALREADY_ACCEPTED, sem segundo débito.

Permissão: captacao:acceptAceita modo ensaioAceita Idempotency-Key

Parâmetros no caminho

offerIdstringobrigatório: Id do proprietário na mesa (cap-…).

Filtros e paginação

dryRunboolean: true = modo ensaio: valida e diz o que aconteceria, sem gravar nada.

Resposta200OK

dataCaptacaoOfferobrigatório: O proprietário (com contato).
resultCaptacaoAcceptResultobrigató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/captacao/offers/cap-8e7d6c5b4a39/accept?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR' \
  -H "Idempotency-Key: $(uuidgen)"

Erros desta rota

E os erros comuns a toda rota

Os objetos

CaptacaoOffer

Um proprietário da Captação. Os campos depois de createdAt só existem depois do aceite.

idstringobrigatório: Id do proprietário na mesa.
statusstringobrigatóriopode vir nulo: Situação.
purposestringobrigatóriopode vir nulo: Venda ou locação.
propertyTypestringobrigatóriopode vir nulo: Subtipo.
citystringobrigatóriopode vir nulo: Cidade.
citySlugstringobrigatóriopode vir nulo: Identificador da cidade.
neighborhoodstringobrigatóriopode vir nulo: Bairro.
bedroomsintegerobrigatóriopode vir nulo: Quartos.
suitesintegerobrigatóriopode vir nulo: Suítes.
bathroomsintegerobrigatóriopode vir nulo: Banheiros.
parkingSpotsintegerobrigatóriopode vir nulo: Vagas.
usableAreaDeclarednumberobrigatóriopode vir nulo: Área útil que o proprietário declarou.
areaDeclarednumberobrigatóriopode vir nulo: Área total que o proprietário declarou.
priceExpectednumberobrigatóriopode vir nulo: Valor que o proprietário espera.
sellTimeframestringobrigatóriopode vir nulo: Prazo para vender: AGORA, TRES_MESES, SEIS_MESES ou PESQUISANDO.
occupancystringobrigatóriopode vir nulo: Ocupação: PROPRIO (o dono mora), ALUGADO ou VAZIO.
ownerRelationstringobrigatóriopode vir nulo: Quem cadastrou: DONO, COPROPRIETARIO, REPRESENTANTE ou OUTRO (não é o proprietário).
exclusivityOpennessstringobrigatóriopode vir nulo: Aceita exclusividade: SIM ou NAO.
alreadyListedDeclaredbooleanobrigatório: Disse que já anuncia em outro lugar.
priceCentsintegerobrigatóriopode vir nulo: O preço do contato, em centavos — o que o aceite debita.
deadlinestringobrigatóriopode vir nulo: Até quando dá para aceitar (o prazo corre só das 9h às 17h, nos dias de atendimento).
matchingClientsobjetoobrigatório: Quantos clientes da conta combinam.
matchingClients.cityintegerobrigatóriopode vir nulo: Clientes da conta que procuram algo assim na cidade (nulo = não deu para calcular).
matchingClients.neighborhoodintegerobrigatóriopode vir nulo: Os mesmos, no bairro.
demandobjetoobrigatóriopode vir nulo: A procura medida pela plataforma.
demand.availablebooleanobrigatório: Há procura medida.
demand.peopleintegerobrigatóriopode vir nulo: Pessoas procurando.
demand.scopestringobrigatóriopode vir nulo: Abrangência.
demand.scopeNamestringobrigatóriopode vir nulo: Nome da abrangência.
demand.asOfstringobrigatóriopode vir nulo: Data da medida.
demand.labelstringobrigatóriopode vir nulo: O que foi medido, por extenso.
stockNeighborhoodintegerobrigatóriopode vir nulo: Imóveis parecidos à venda no bairro.
ownerNameMaskedstringobrigatóriopode vir nulo: Nome mascarado (antes do aceite).
ownerPhoneVerifiedViastringobrigatóriopode vir nulo: Como o telefone do proprietário foi confirmado.
ownerPhoneVerifiedAtstringobrigatóriopode vir nulo: Quando.
revealedbooleanobrigatório: O contato já foi liberado para a conta (aceito). Antes disso, owner e address NÃO existem na resposta.
createdAtstringobrigatório: Quando foi criado (UTC).
ownerobjeto: O proprietário (só depois do aceite).
owner.namestringobrigatóriopode vir nulo: Nome.
owner.phonestringobrigatóriopode vir nulo: Telefone.
owner.emailstringobrigatóriopode vir nulo: E-mail.
addressobjeto: O endereço (só depois do aceite).
address.streetstringobrigatóriopode vir nulo: Rua.
address.numberstringobrigatóriopode vir nulo: Número.
address.complementstringobrigatóriopode vir nulo: Complemento.
address.neighborhoodstringobrigatóriopode vir nulo: Bairro.
address.citystringobrigatóriopode vir nulo: Cidade.
acceptedAtstringpode vir nulo: Quando foi aceito.
acceptedViaobjetopode vir nulo: Como foi aceito: pela tela ou pela API (com a chave, o IP e a versão do termo).
refundUntilstringpode vir nulo: Até quando cabe pedir devolução.
refundedAtstringpode vir nulo: Quando foi devolvido.
soldAtstringpode vir nulo: Quando o imóvel foi vendido.
stagestringpode vir nulo: Etapa na mesa.
stageLabelstringpode vir nulo: Etapa por extenso.
lostReasonstringpode vir nulo: Motivo da perda.
notestringpode vir nulo: Anotação.
tabstringpode vir nulo: Aba da mesa: ACTIVE, CAPTURED ou ARCHIVED.

CaptacaoSummary

O resumo da mesa.

pendingCountintegerobrigatório: Proprietários na vez da conta agora.
balanceCentsintegerobrigatório: Crédito, em centavos.
subscriptionActivebooleanobrigatório: Assinatura do módulo em dia.
platformActivebooleanobrigatório: O módulo está valendo na plataforma.
pausedbooleanobrigatório: A conta pausou o recebimento.
pausedAutobooleanobrigatório: Pausa automática (prazos vencidos em sequência).
expiredStreakintegerobrigatório: Prazos vencidos em sequência.
autoPauseAfterintegerobrigatóriopode vir nulo: A pausa automática vem depois de quantos.
inActivationbooleanobrigatório: Em ativação (antes da 1ª recarga).
leadsToFirstChargeintegerobrigatóriopode vir nulo: Aceites até a 1ª recarga.
rechargePendingbooleanobrigatório: Recarga em andamento.
operatingCitieslista de stringobrigatório: Cidades atendidas.
purposeslista de stringobrigatório: Finalidades atendidas.
serviceDayslista de stringobrigatório: Dias de atendimento.

CaptacaoAcceptResult

O desfecho do aceite.

outcomestringobrigatório: ACCEPTED, ALREADY_ACCEPTED (sem segundo débito) ou, em ensaio, WOULD_ACCEPT.
dryRunbooleanobrigatório: Foi um ensaio — nada foi debitado.
priceCentsintegerobrigatóriopode vir nulo: O valor debitado (ou que seria), em centavos.