Tools do Kit
As 13 operações do Kit que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar inscritosGETLista os inscritos com id, e-mail, nome, estado e campos personalizados, apenas os ativos por padrão. Busque um por email_address. A resposta traz subscribers e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Criar inscritoPOSTCria um inscrito ativo. Quando o e-mail já pertence a um inscrito, atualiza o nome desse inscrito em vez disso. Não adiciona tag: use Apply tag em seguida.
- Atualizar inscritoPUTAtualiza o e-mail, o nome ou os campos personalizados de um inscrito. Uma chave de campo personalizado que não existe na conta faz a requisição falhar.
- Listar tagsGETLista as tags com id, nome e data de criação. A resposta traz tags e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Criar tagPOSTCria uma tag e a retorna com seu id. Quando já existe uma tag com o mesmo nome, sem diferenciar maiúsculas, retorna essa tag em vez de uma duplicada.
- Aplicar tagPOSTAplica uma tag a um inscrito existente, encontrado pelo e-mail. As automações da conta que começam com essa tag rodam para o inscrito. Crie o inscrito antes com Create subscriber.
- Listar formuláriosGETLista os formulários e landing pages com id, nome, tipo e URL de incorporação, apenas os ativos por padrão. A resposta traz forms e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Listar segmentosGETLista os segmentos com id e nome. Os segmentos são criados no app do Kit, e seus ids definem o público de um broadcast em subscriber_filter. A resposta traz segments e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Listar broadcastsGETLista os broadcasts com id, assunto, conteúdo, status, send_at, segmentação e template de e-mail. A resposta traz broadcasts e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Criar broadcastPOSTCria um e-mail broadcast como rascunho, ou o agenda quando send_at está definido. Vai para todos os inscritos, ou apenas para os segmentos e tags de subscriber_filter. Retorna o broadcast com seu id.
- Atualizar broadcastPUTAtualiza um broadcast em rascunho ou agendado. Envie subject e content em toda atualização, copiados de List broadcasts quando não mudam. Definir send_at agenda o envio, e null devolve o broadcast a rascunho.
- Listar estatísticas de broadcastsGETRetorna, para cada broadcast com id, assunto e send_at, os destinatários, aberturas, taxa de abertura, cliques, taxa de cliques, descadastros e status de envio. A resposta traz broadcasts e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Obter estatísticas de crescimentoGETRetorna os inscritos no fim do período, os novos inscritos, os cancelamentos e o saldo de novos inscritos entre starting e ending, contados no fuso horário de envio da conta. O período padrão são os últimos 90 dias.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
