Tools do Intercom
As 13 operações do Intercom que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar contatosGETLista os contatos do workspace, usuários e leads, 10 por página por padrão. A próxima página vem de pages.next.starting_after na resposta; sem ele, esta é a última página. Contatos mesclados não aparecem.
- Buscar contatosPOSTBusca contatos pelos seus atributos, por exemplo por email, role ou um atributo customizado. Timestamps são segundos Unix em UTC. Retorna total_count e data, 50 por página por padrão, e a próxima página vem de pages.next.starting_after. Um contato criado nos últimos minutos pode ainda não aparecer.
- Obter contatoGETRetorna um contato com role, email, telefone, nome, owner_id, custom_attributes, tags, empresas e localização. Um contato mesclado em outro retorna 410.
- Criar contatoPOSTCria um contato, usuário ou lead. Envie ao menos um entre email, external_id ou role. Todo atributo customizado enviado já deve existir no workspace, ou o Intercom recusa o contato.
- Atualizar contatoPUTAtualiza um contato: envie só os campos a alterar. Um usuário não pode virar lead. Todo atributo customizado enviado já deve existir no workspace.
- Listar conversasGETLista as conversas do workspace, 20 por página por padrão. A próxima página vem de pages.next.starting_after na resposta; sem ele, esta é a última página. Obter conversa retorna todas as partes de uma conversa.
- Buscar conversasPOSTBusca conversas pelos seus atributos, por exemplo as abertas atribuídas a um membro da equipe ou a um time. Timestamps são segundos Unix. Retorna total_count e conversations, 20 por página por padrão, e a próxima página vem de pages.next.starting_after.
- Obter conversaGETRetorna uma conversa com suas partes (mensagens, notas e ações), até as 500 mais recentes, além de state, responsáveis, contatos e tags.
- Responder conversaPOSTResponde a uma conversa como membro da equipe. Um comment chega ao contato pelo canal da conversa, como o Messenger ou email; uma note fica interna, visível só para a equipe. Fechar, adiar, reabrir e atribuir são feitos por Gerenciar conversa.
- Gerenciar conversaPOSTFecha, adia, reabre ou atribui uma conversa. close exige type admin; snoozed exige snoozed_until; assignment exige type e assignee_id, e uma conversa pode ter um admin e um time atribuídos ao mesmo tempo. Atribuir uma conversa fechada a reabre, a menos que skip_reopen seja true.
- Criar mensagemPOSTEnvia uma nova mensagem de um membro da equipe a um contato, no Messenger (in_app) ou por email. Email exige subject e template. A conversa só existe depois que o contato responde, a menos que create_conversation_without_contact_reply seja true.
- Listar membros da equipeGETLista os membros da equipe (admins) do workspace com id, nome, email, away_mode_enabled e team_ids. O id é o admin_id de respostas e ações de conversa e o owner_id de contatos.
- Listar timesGETLista os times do workspace com id, nome e admin_ids. O id é o assignee_id de uma conversa atribuída a um time.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
