Pesquisar antes de criar

  • GET /v2/api/external/{ApiID}/listContacts consulta contatos com pageNumber, searchParam, walletId e tagId.
  • POST .../contacts/search permite usar searchParam, page, limit e tagId.
  • POST .../showcontact pesquisa pelo number e recebe validateNumber.
  • GET .../getContactExtraInfo consulta os dados complementares pelo contactId.
Tela de Contatos do Atendeu Rápido com busca, filtros e utilitários
Compare o retorno da API com a área Contatos antes de criar ou alterar um cadastro.

Criar um contato controlado

  1. 1

    Pesquise por número e por outros dados disponíveis para reduzir o risco de duplicidade.

  2. 2

    Abra POST /v2/api/external/{ApiID}/createContact no sandbox.

  3. 3

    Preencha somente os campos necessários entre name, number, email, cpf, firstName, lastName, businessName, birthdayDate, externalKey e validateNumber.

  4. 4

    Envie um único contato fictício ou autorizado.

  5. 5

    Pesquise novamente e registre o identificador retornado pela sua versão, quando disponível.

  6. 6

    Confira o cadastro na interface.

Formulário vazio de novo contato no Atendeu Rápido
A interface ajuda a conferir o resultado, mas a API só deve receber os campos publicados no schema da rota.

Atualizar dados e vínculos

  • POST .../updateContact publica dados cadastrais, kanban, externalKey e validateNumber, mas não documenta um contactId no corpo.
  • POST .../updateContactExtraInfo recebe contactId e uma coleção extraInfo com pares name e value.
  • POST .../updateContactKanban recebe contactId e kanban.
  • POST .../updateContactWallet recebe contactId e walletId.
  • POST .../blockContact recebe contactId e blocked para bloquear ou desbloquear.

Detectar, mesclar e desfazer duplicidades

  1. 1

    Use POST .../findduplicatecontacts com um limite pequeno e os matchKinds aceitos pela sua versão.

  2. 2

    Revise manualmente cada par e confirme qual cadastro deve ser o principal.

  3. 3

    Em POST .../mergecontacts, envie somente pares primaryId e duplicateId já conferidos.

  4. 4

    Valide mensagens, tickets, carteiras e campos adicionais do cadastro resultante.

  5. 5

    Se a mesclagem precisar ser desfeita, use POST .../unmergecontacts com duplicateIds e mergeLogIds obtidos no processo.

Diagnosticar sem expor dados pessoais

  • Contato não localizado: compare searchParam, number, filtros e o comportamento de validateNumber.
  • Duplicidade criada: interrompa novas criações e pesquise antes de decidir pela mesclagem.
  • Carteira ou Kanban não aplicado: confirme IDs existentes no mesmo ambiente.
  • Campo extra desapareceu: restaure a partir da leitura anterior e valide se houve substituição da coleção.
  • Atualização atingiu outro registro: suspenda a integração e revise a forma como updateContact identifica o contato.