Parcerias

As parcerias da equipe, com a etapa e as duas pontas. Só o lado que captou o cliente move o funil.

GET/v1/partnerships— Parcerias da equipe
GET/v1/partnerships/{partnershipId}— Uma parceria
POST/v1/partnerships/{partnershipId}/status— Mover a etapa da parceria

As rotas

GET/v1/partnerships

Parcerias da equipe

Todas as parcerias numa resposta. O nextCursor existe no contrato para quando ela paginar — siga-o desde já.

Permissão: partnerships:read

Filtros e paginação

statusstring: Etapa.um de PENDING ACCEPTED DECLINED CANCELLED LEAD_REGISTERED CONTACTED NEGOTIATING PROPOSAL WON LOST
updatedSincestring: Só o que mudou desde esta data/hora (ISO 8601, UTC).

Resposta200OK

datalista de Partnershipobrigatório: As parcerias.
nextCursorstringobrigatóriopode vir nulo: Cursor da próxima página (nulo = acabou).

Exemplo

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

Erros desta rota

E os erros comuns a toda rota

GET/v1/partnerships/{partnershipId}

Uma parceria

A parceria, com as duas pontas e quem pode mover o funil.

Permissão: partnerships:read

Parâmetros no caminho

partnershipIdstringobrigatório: Id da parceria (pship-…).

Resposta200OK

dataPartnershipobrigatório: A parceria.

Exemplo

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

Erros desta rota

404not_found

E os erros comuns a toda rota

POST/v1/partnerships/{partnershipId}/status

Mover a etapa da parceria

Só o lado que captou o cliente move o funil (canMoveFunnel). A contraparte só encerra depois de pedir atualização e ficar 15 dias sem resposta — a regra da tela.

Permissão: partnerships:writeAceita modo ensaioAceita Idempotency-Key

Parâmetros no caminho

partnershipIdstringobrigatório: Id da parceria (pship-…).

Filtros e paginação

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

Corpo do pedido

statusstringobrigatório: A nova etapa.um de PENDING ACCEPTED DECLINED CANCELLED LEAD_REGISTERED CONTACTED NEGOTIATING PROPOSAL WON LOST

Exemplo de corpo

{
  "status": "PROPOSAL"
}

Resposta200OK

dataPartnershipobrigatório: O objeto como ficou.
resultPartnershipWriteResultobrigató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/partnerships/pship-5b8d2f1e9a3c/status?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "status": "PROPOSAL"
}
JSON

Erros desta rota

E os erros comuns a toda rota

Os objetos

Party

Uma ponta da parceria.

accountIdstringobrigatóriopode vir nulo: Id da conta.
namestringobrigatóriopode vir nulo: Nome.
typestringobrigatóriopode vir nulo: Tipo de conta.

Partnership

Uma parceria.

idstringobrigatório: Id da parceria.
statusstringobrigatório: Etapa.um de PENDING ACCEPTED DECLINED CANCELLED LEAD_REGISTERED CONTACTED NEGOTIATING PROPOSAL WON LOST
kindstringobrigatóriopode vir nulo: CLIENT_FOR_PROPERTY ou PROPERTY_FOR_CLIENT.
propertyIdstringobrigatóriopode vir nulo: Imóvel.
leadIdstringobrigatóriopode vir nulo: Cliente.
matchIdstringobrigatóriopode vir nulo: A oportunidade de origem.
developmentIdstringobrigatóriopode vir nulo: Empreendimento (registro em lançamento).
developmentTitlestringobrigatóriopode vir nulo: Nome do empreendimento.
scoreintegerobrigatóriopode vir nulo: Nota da oportunidade.
summarystringobrigatóriopode vir nulo: Resumo.
reasonslista de stringobrigatório: Por que combina.
messagestringobrigatóriopode vir nulo: Mensagem do pedido.
ourSidestringobrigatóriopode vir nulo: O lado da conta: REQUESTER (pediu) ou ADDRESSEE (recebeu).
ourBrokerIdstringobrigatóriopode vir nulo: O corretor da casa na parceria.
canMoveFunnelbooleanobrigatório: A conta pode mover a etapa — só o lado que captou o cliente pode.
requesterPartyobrigatóriopode vir nulo: Quem pediu.
addresseePartyobrigatóriopode vir nulo: Quem recebeu.
counterpartobjetoobrigatório: O parceiro do outro lado.
counterpart.namestringobrigatóriopode vir nulo: Nome.
counterpart.typestringobrigatóriopode vir nulo: Tipo de conta.
counterpart.organizationstringobrigatóriopode vir nulo: Imobiliária.
counterpart.contactNamestringobrigatóriopode vir nulo: Contato.
counterpart.phonestringobrigatóriopode vir nulo: Telefone.
counterpart.emailstringobrigatóriopode vir nulo: E-mail.
counterpart.crecistringobrigatóriopode vir nulo: CRECI.
counterpart.creciVerifiedbooleanobrigatório: CRECI conferido.
propertyPropertySnapshotobrigatóriopode vir nulo: O imóvel.
clientClientSnapshotobrigatóriopode vir nulo: O cliente.
lastProgressAtstringobrigatóriopode vir nulo: Último avanço de etapa.
protectedUntilstringobrigatóriopode vir nulo: Até quando o cliente fica protegido (lançamento).
propertyOffMarketAtstringobrigatóriopode vir nulo: Quando o imóvel saiu do ar.
createdAtstringobrigatório: Quando foi criado (UTC).
updatedAtstringobrigatório: Última alteração (UTC).

PartnershipWriteResult

O desfecho.

outcomestringobrigatório: O que aconteceu.
dryRunbooleanobrigatório: Foi um ensaio.