ImobyFlowParcerias Imobiliárias
Navegar na documentação
English

Clientes

Os clientes da conta, com o perfil de busca que liga as recomendações: ler, sincronizar pelo código do seu sistema, mover no funil, arquivar e registrar atendimentos.

As rotas

GET/v1/leads

Listar clientes

Os clientes da conta, mais recentes antes, com filtros.

Permissão: leads:read

Filtros e paginação

limitinteger
Itens por página: de 1 a 100 (padrão 50).
cursorstring
O nextCursor da página anterior. A lista acabou quando ele vem nulo. Ele vale só para esta rota e esta conta.
statestring
ACTIVE (padrão), ARCHIVED ou DELETED.um de ACTIVE ARCHIVED DELETED
statusstring
Etapa.um de NEW ATTENDING PROPOSAL WON LOST
ownerAccountIdstring
Só os de um corretor.
updatedSincestring
Só o que mudou desde esta data/hora (ISO 8601, UTC).
radarstring
pending = só quem tem pendência para as recomendações; ready = só quem está pronto.um de pending ready

Resposta200OK

datalista de Leadobrigatório
Os clientes.
nextCursorstringobrigatóriopode vir nulo
Cursor da próxima página (nulo = acabou).

Exemplo

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

Erros desta rota

E os erros comuns a toda rota

GET/v1/leads/{leadId}

Um cliente

O cliente, com o perfil de busca e a situação nas recomendações.

Permissão: leads:read

Parâmetros no caminho

leadIdstringobrigatório
Id do cliente (lead-…).

Resposta200OK

dataLeadobrigatório
O cliente.

Exemplo

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

Erros desta rota

E os erros comuns a toda rota

GET/v1/leads/by-ref/{ref}

Um cliente pelo seu código

O cliente pelo código do seu sistema.

Permissão: leads:read

Parâmetros no caminho

refstringobrigatório
O código do cliente no seu sistema (até 80 caracteres).

Resposta200OK

dataLeadobrigatório
O cliente.

Exemplo

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

Erros desta rota

E os erros comuns a toda rota

PUT/v1/leads/by-ref/{ref}

Criar, atualizar ou vincular pelo seu código

Cria o cliente (201), atualiza (200) — ou VINCULA: o código é novo, mas a pessoa já está aqui pelo telefone ou e-mail (veio de um portal, da planilha); o código passa a apontar para ela (LINKED), sem um segundo cliente. Na criação, consentGiven: true é obrigatório.

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

Parâmetros no caminho

refstringobrigatório
O código do cliente no seu sistema (até 80 caracteres).

Filtros e paginação

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

Corpo do pedido

externalRefstring
O código do cliente no seu sistema (só no POST).
namestring
Nome. Obrigatório na criação.
phoneslista de PhoneInput
Até 5 telefones. Na criação, telefone ou e-mail.
emailstringpode vir nulo
E-mail.
statusstring
Etapa do atendimento.um de NEW ATTENDING PROPOSAL WON LOST
notesstring
Anotações.
preApprovedboolean
Crédito pré-aprovado.
sharedToNetworkboolean
O perfil pode receber imóveis de parceiros.
interestInterestInput
Perfil de busca.
ownerAccountIdstring
O corretor responsável, pelo id.
ownerEmailstring
O corretor responsável, pelo e-mail — é como o seu sistema o conhece. Sem responsável, vale a distribuição da imobiliária.
lastActivityAtstring
A última movimentação no SEU sistema. Só anda para a frente. Mais de 60 dias atrás na criação = o cliente entra arquivado (base histórica).
consentGivenboolean
Obrigatório true na criação: a imobiliária declara ter a base legal para tratar o dado (Termos da API).

Exemplo de corpo

{
  "name": "Carlos Pereira",
  "phones": [
    {
      "number": "(41) 99999-8888",
      "isWhatsApp": true
    }
  ],
  "email": "carlos@example.com",
  "status": "ATTENDING",
  "ownerEmail": "marina@suaimobiliaria.com.br",
  "interest": {
    "purposes": [
      "VENDA"
    ],
    "propertyTypes": [
      "APARTAMENTO"
    ],
    "locations": [
      {
        "cityId": "4106902",
        "neighborhoodSlug": "bigorrilho"
      }
    ],
    "salePriceMax": 950000,
    "bedrooms": 3
  },
  "lastActivityAt": "2026-10-02T15:00:00Z",
  "consentGiven": true
}

Resposta200OK201 quando cria.

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 PUT 'https://api.imobyflow.com.br/v1/leads/by-ref/CLI-889?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "name": "Carlos Pereira",
  "phones": [
    {
      "number": "(41) 99999-8888",
      "isWhatsApp": true
    }
  ],
  "email": "carlos@example.com",
  "status": "ATTENDING",
  "ownerEmail": "marina@suaimobiliaria.com.br",
  "interest": {
    "purposes": [
      "VENDA"
    ],
    "propertyTypes": [
      "APARTAMENTO"
    ],
    "locations": [
      {
        "cityId": "4106902",
        "neighborhoodSlug": "bigorrilho"
      }
    ],
    "salePriceMax": 950000,
    "bedrooms": 3
  },
  "lastActivityAt": "2026-10-02T15:00:00Z",
  "consentGiven": true
}
JSON

Erros desta rota

E os erros comuns a toda rota

POST/v1/leads

Cadastrar um cliente

Cria um cliente. O mínimo: name, um telefone ou e-mail e consentGiven: true. Contato que já existe → 409 com o id. Sem responsável, vale a distribuição da imobiliária.

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

Filtros e paginação

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

Corpo do pedido

externalRefstring
O código do cliente no seu sistema (só no POST).
namestring
Nome. Obrigatório na criação.
phoneslista de PhoneInput
Até 5 telefones. Na criação, telefone ou e-mail.
emailstringpode vir nulo
E-mail.
statusstring
Etapa do atendimento.um de NEW ATTENDING PROPOSAL WON LOST
notesstring
Anotações.
preApprovedboolean
Crédito pré-aprovado.
sharedToNetworkboolean
O perfil pode receber imóveis de parceiros.
interestInterestInput
Perfil de busca.
ownerAccountIdstring
O corretor responsável, pelo id.
ownerEmailstring
O corretor responsável, pelo e-mail — é como o seu sistema o conhece. Sem responsável, vale a distribuição da imobiliária.
lastActivityAtstring
A última movimentação no SEU sistema. Só anda para a frente. Mais de 60 dias atrás na criação = o cliente entra arquivado (base histórica).
consentGivenboolean
Obrigatório true na criação: a imobiliária declara ter a base legal para tratar o dado (Termos da API).

Exemplo de corpo

{
  "externalRef": "CLI-889",
  "name": "Carlos Pereira",
  "phones": [
    {
      "number": "(41) 99999-8888",
      "isWhatsApp": true
    }
  ],
  "email": "carlos@example.com",
  "status": "ATTENDING",
  "ownerEmail": "marina@suaimobiliaria.com.br",
  "interest": {
    "purposes": [
      "VENDA"
    ],
    "propertyTypes": [
      "APARTAMENTO"
    ],
    "locations": [
      {
        "cityId": "4106902",
        "neighborhoodSlug": "bigorrilho"
      }
    ],
    "salePriceMax": 950000,
    "bedrooms": 3
  },
  "lastActivityAt": "2026-10-02T15:00:00Z",
  "consentGiven": true
}

Resposta201Criado

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?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "externalRef": "CLI-889",
  "name": "Carlos Pereira",
  "phones": [
    {
      "number": "(41) 99999-8888",
      "isWhatsApp": true
    }
  ],
  "email": "carlos@example.com",
  "status": "ATTENDING",
  "ownerEmail": "marina@suaimobiliaria.com.br",
  "interest": {
    "purposes": [
      "VENDA"
    ],
    "propertyTypes": [
      "APARTAMENTO"
    ],
    "locations": [
      {
        "cityId": "4106902",
        "neighborhoodSlug": "bigorrilho"
      }
    ],
    "salePriceMax": 950000,
    "bedrooms": 3
  },
  "lastActivityAt": "2026-10-02T15:00:00Z",
  "consentGiven": true
}
JSON

Erros desta rota

E os erros comuns a toda rota

PATCH/v1/leads/{leadId}

Alterar parte de um cliente

Muda só o que vier. Mudar a etapa entra no histórico, mas não conta como movimentação — para isso mande lastActivityAt ou registre um atendimento.

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

Parâmetros no caminho

leadIdstringobrigatório
Id do cliente (lead-…).

Filtros e paginação

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

Corpo do pedido

externalRefstring
O código do cliente no seu sistema (só no POST).
namestring
Nome. Obrigatório na criação.
phoneslista de PhoneInput
Até 5 telefones. Na criação, telefone ou e-mail.
emailstringpode vir nulo
E-mail.
statusstring
Etapa do atendimento.um de NEW ATTENDING PROPOSAL WON LOST
notesstring
Anotações.
preApprovedboolean
Crédito pré-aprovado.
sharedToNetworkboolean
O perfil pode receber imóveis de parceiros.
interestInterestInput
Perfil de busca.
ownerAccountIdstring
O corretor responsável, pelo id.
ownerEmailstring
O corretor responsável, pelo e-mail — é como o seu sistema o conhece. Sem responsável, vale a distribuição da imobiliária.
lastActivityAtstring
A última movimentação no SEU sistema. Só anda para a frente. Mais de 60 dias atrás na criação = o cliente entra arquivado (base histórica).
consentGivenboolean
Obrigatório true na criação: a imobiliária declara ter a base legal para tratar o dado (Termos da API).

Exemplo de corpo

{
  "status": "PROPOSAL",
  "lastActivityAt": "2026-10-02T15:00:00Z"
}

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 PATCH 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f?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",
  "lastActivityAt": "2026-10-02T15:00:00Z"
}
JSON

Erros desta rota

E os erros comuns a toda rota

POST/v1/leads/{leadId}/state

Arquivar ou reativar

ARCHIVED arquiva; ACTIVE reativa. A mesma função da tela.

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

Parâmetros no caminho

leadIdstringobrigatório
Id do cliente (lead-…).

Filtros e paginação

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

Corpo do pedido

statestringobrigatório
O estado.um de ACTIVE ARCHIVED

Exemplo de corpo

{
  "state": "ARCHIVED"
}

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/state?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "state": "ARCHIVED"
}
JSON

Erros desta rota

E os erros comuns a toda rota

POST/v1/leads/{leadId}/interactions

Registrar um atendimento

Contato, visita, proposta ou anotação feitos no SEU sistema, com a data dele. Conta como movimentação (o cliente não é arquivado por inatividade).

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

Parâmetros no caminho

leadIdstringobrigatório
Id do cliente (lead-…).

Filtros e paginação

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

Corpo do pedido

typestringobrigatório
CONTACT, VISIT, PROPOSAL ou NOTE.um de CONTACT VISIT PROPOSAL NOTE
notestring
Anotação.
atstring
Quando aconteceu (padrão: agora).

Exemplo de corpo

{
  "type": "VISIT",
  "note": "Visitou o AP1234 com a esposa.",
  "at": "2026-10-02T15:00:00Z"
}

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/interactions?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "type": "VISIT",
  "note": "Visitou o AP1234 com a esposa.",
  "at": "2026-10-02T15:00:00Z"
}
JSON

Erros desta rota

E os erros comuns a toda rota

DELETE/v1/leads/{leadId}

Mandar para a lixeira

Lixeira de 30 dias; cancela as parcerias abertas do cliente, como a tela. A mesma trava de encolhimento dos imóveis.

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

Parâmetros no caminho

leadIdstringobrigatório
Id do cliente (lead-…).

Filtros e paginação

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

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 DELETE 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f?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

Phone

Um telefone.

numberstringobrigatório
Só dígitos, com DDD (10 a 13).
isWhatsAppbooleanobrigatório
É WhatsApp.
labelstringobrigatóriopode vir nulo
Rótulo livre (celular, trabalho…).

Location

Uma região de interesse.

cityIdstringobrigatóriopode vir nulo
Código do IBGE.
citySlugstringobrigatóriopode vir nulo
Identificador da cidade.
cityNamestringobrigatóriopode vir nulo
Nome da cidade.
ufstringobrigatóriopode vir nulo
Estado.
neighborhoodSlugstringobrigatóriopode vir nulo
Bairro do catálogo (nulo = a cidade inteira).
neighborhoodNamestringobrigatóriopode vir nulo
Nome do bairro.
preferencestringobrigatório
PREFERRED (preferido) ou ACCEPTABLE (aceitável) — pesa na nota da recomendação.um de PREFERRED ACCEPTABLE

Interest

O perfil de busca — é ele que liga as recomendações.

purposeslista de stringobrigatório
Finalidades: VENDA, LOCACAO ou as duas.um de VENDA LOCACAO
propertyTypeslista de stringobrigatório
Tipos de imóvel procurados.um de APARTAMENTO CASA_RUA CASA_CONDOMINIO CASA_VILA STUDIO FLAT COBERTURA SALA_COMERCIAL LOJA_PONTO GALPAO PREDIO TERRENO_RUA TERRENO_CONDOMINIO CHACARA_SITIO FAZENDA
locationslista de Locationobrigatório
Regiões de interesse.
similarNeighborhoodsbooleanobrigatório
Aceita bairros parecidos com os escolhidos.
salePriceMinnumberobrigatóriopode vir nulo
Compra: piso, em reais.
salePriceMaxnumberobrigatóriopode vir nulo
Compra: teto, em reais.
rentPriceMinnumberobrigatóriopode vir nulo
Aluguel: piso, em reais.
rentPriceMaxnumberobrigatóriopode vir nulo
Aluguel: teto, em reais.
bedroomsintegerobrigatóriopode vir nulo
Quartos, no mínimo.
bathroomsintegerobrigatóriopode vir nulo
Banheiros, no mínimo.
parkingSpotsintegerobrigatóriopode vir nulo
Vagas, no mínimo.
areaMinnumberobrigatóriopode vir nulo
Área mínima, em m².

LeadRadar

A situação do cliente nas recomendações.

eligiblebooleanobrigatório
Recebe recomendações agora (ativo e sem pendência).
pendinglista de stringobrigatório
O que falta no perfil de busca.um de PURPOSE_MISSING PROPERTY_TYPES_MISSING CITY_MISSING CITY_NOT_IN_CATALOG BUDGET_MISSING SALE_BUDGET_MISSING RENT_BUDGET_MISSING OTHER
labelslista de stringobrigatório
As mesmas pendências, por extenso.

Lead

Um cliente da conta. Nome, telefone e e-mail são dado pessoal — a imobiliária é a controladora.

idstringobrigatório
Id do cliente.
externalRefstringobrigatóriopode vir nulo
O código do cliente no SEU sistema.
ownerAccountIdstringobrigatóriopode vir nulo
O corretor responsável (ou a própria imobiliária).
statestringobrigatório
ACTIVE, ARCHIVED ou DELETED (lixeira).um de ACTIVE ARCHIVED DELETED
statusstringobrigatóriopode vir nulo
Etapa do atendimento.um de NEW ATTENDING PROPOSAL WON LOST
namestringobrigatóriopode vir nulo
Nome.
phoneslista de Phoneobrigatório
Telefones.
emailstringobrigatóriopode vir nulo
E-mail.
sourcestringobrigatório
Por onde chegou: MANUAL, IMPORT_CSV, EMAIL, WEBHOOK, META_ADS, PORTAL_API, CRM_API (pela API)…
sourceDetailstringobrigatóriopode vir nulo
Detalhe da origem (o portal, o nome do sistema).
sourcePropertyIdstringobrigatóriopode vir nulo
O imóvel que trouxe o cliente, quando houver.
preApprovedbooleanobrigatório
Crédito pré-aprovado.
sharedToNetworkbooleanobrigatório
O perfil (sem nome nem contato) pode receber imóveis de parceiros.
notesstringobrigatóriopode vir nulo
Anotações.
interestInterestobrigatório
Perfil de busca.
radarLeadRadarobrigatório
Situação nas recomendações.
lastActivityAtstringobrigatóriopode vir nulo
Última movimentação — anda pela data que o seu sistema manda e pelos atendimentos, nunca pela sincronização.
archivedAtstringobrigatóriopode vir nulo
Quando foi arquivado.
archivedReasonstringobrigatóriopode vir nulo
Por que foi arquivado (MANUAL, INACTIVITY, IMPORT…).
deletedAtstringobrigatóriopode vir nulo
Quando foi para a lixeira.
createdAtstringobrigatório
Quando foi criado (UTC).
updatedAtstringobrigatório
Última alteração (UTC).

PhoneInput

Um telefone. Também aceita só o número, em texto.

numberstring
Com DDD; só os dígitos contam.
isWhatsAppboolean
É WhatsApp (padrão: sim).
labelstring
Rótulo livre.

LocationInput

Uma região de interesse.

cityIdstring
Código do IBGE.
cityNamestring
Nome da cidade (com uf).
ufstring
Estado.
neighborhoodSlugstring
Bairro do catálogo.
neighborhoodNamestring
Bairro em texto. Área de mercado ("Ecoville") vira os bairros do catálogo que ela cobre.
preferencestring
PREFERRED (padrão) ou ACCEPTABLE.um de PREFERRED ACCEPTABLE

InterestInput

O perfil de busca. É mesclado campo a campo: mandar só o teto não apaga as regiões.

purposeslista de string
Finalidades.um de VENDA LOCACAO
propertyTypeslista de string
Tipos procurados.um de APARTAMENTO CASA_RUA CASA_CONDOMINIO CASA_VILA STUDIO FLAT COBERTURA SALA_COMERCIAL LOJA_PONTO GALPAO PREDIO TERRENO_RUA TERRENO_CONDOMINIO CHACARA_SITIO FAZENDA
locationslista de LocationInput
Regiões (até 20). Quando vem, vem inteira.
similarNeighborhoodsboolean
Aceita bairros parecidos.
salePriceMinnumberpode vir nulo
Compra: piso.
salePriceMaxnumberpode vir nulo
Compra: teto. Abaixo do piso é recusado.
rentPriceMinnumberpode vir nulo
Aluguel: piso.
rentPriceMaxnumberpode vir nulo
Aluguel: teto. Abaixo do piso é recusado.
bedroomsintegerpode vir nulo
Quartos, no mínimo.
bathroomsintegerpode vir nulo
Banheiros, no mínimo.
parkingSpotsintegerpode vir nulo
Vagas, no mínimo.
areaMinnumberpode vir nulo
Área mínima, em m².

LeadInput

Os campos que a API aceita no cliente. Campo desconhecido é erro; campo ausente não apaga.

externalRefstring
O código do cliente no seu sistema (só no POST).
namestring
Nome. Obrigatório na criação.
phoneslista de PhoneInput
Até 5 telefones. Na criação, telefone ou e-mail.
emailstringpode vir nulo
E-mail.
statusstring
Etapa do atendimento.um de NEW ATTENDING PROPOSAL WON LOST
notesstring
Anotações.
preApprovedboolean
Crédito pré-aprovado.
sharedToNetworkboolean
O perfil pode receber imóveis de parceiros.
interestInterestInput
Perfil de busca.
ownerAccountIdstring
O corretor responsável, pelo id.
ownerEmailstring
O corretor responsável, pelo e-mail — é como o seu sistema o conhece. Sem responsável, vale a distribuição da imobiliária.
lastActivityAtstring
A última movimentação no SEU sistema. Só anda para a frente. Mais de 60 dias atrás na criação = o cliente entra arquivado (base histórica).
consentGivenboolean
Obrigatório true na criação: a imobiliária declara ter a base legal para tratar o dado (Termos da API).

LeadWriteResult

O desfecho da escrita.

outcomestringobrigatório
O que aconteceu: CREATED, UPDATED, UNCHANGED, LINKED (o código passou a apontar para um cliente que já existia pelo contato), ARCHIVED (criado arquivado, base histórica), STATE_SET (arquivado ou reativado), ADDED (atendimento registrado), DELETED, ALREADY_DELETED.
dryRunbooleanobrigatório
Foi um ensaio — nada foi gravado.
interactionobjeto
O atendimento registrado (só em POST /leads/{leadId}/interactions).
interaction.idstringobrigatório
Id do registro.
interaction.typestringobrigatório
Tipo.
interaction.notestringobrigatóriopode vir nulo
Anotação.
interaction.atstringobrigatóriopode vir nulo
Quando aconteceu.