Tools do beehiiv
As 12 operações do beehiiv que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar publicaçõesGETLista as publicações que a API key alcança, com id, name e organization_name. expand stats adiciona assinaturas ativas, taxas médias de abertura e clique e totais enviados. Pagine com page e limit, até 100; a resposta traz total_pages.
- Listar assinaturasGETLista as assinaturas (inscritos) de uma publicação, opcionalmente só de um email, status ou tier. Pagine com limit, até 100, e cursor: a resposta traz has_more e next_cursor.
- Obter assinaturaGETRetorna uma assinatura com email, status, created, subscription_tier, os campos utm e referral_code.
- Criar assinaturaPOSTInscreve um email em uma publicação e retorna a assinatura com seu id. Com double opt-in na publicação, ou double_opt_override ativado, a pessoa confirma por email antes de ficar ativa.
- Atualizar assinaturaPATCHAtualiza uma assinatura. Só os campos enviados mudam. unsubscribe true cancela a inscrição da pessoa na publicação.
- Criar tag de assinaturaPOSTAdiciona tags a uma assinatura. Uma tag que ainda não existe na publicação é criada.
- Listar postsGETLista os posts de uma publicação com id, title, subtitle, status, publish_date e web_url. expand stats adiciona as estatísticas de email e web de cada post. Pagine com page e limit, até 100; a resposta traz total_pages.
- Obter postGETRetorna um post; expand stats adiciona suas estatísticas de email e web. Um post criado há pouco pode responder 202 enquanto o beehiiv o monta, e 404 com POST_CREATION_FAILED quando a criação falhou.
- Criar postPOSTCria um post a partir de HTML e retorna seu id; só nos planos Pro e Enterprise. status draft, o padrão, apenas salva; confirmed envia e publica na hora ou em scheduled_at. O beehiiv monta o post em segundo plano, então Get post pode responder 202 por um instante.
- Atualizar postPATCHAtualiza um post; só nos planos Pro e Enterprise. Só os campos enviados mudam, e body_content substitui todo o conteúdo. scheduled_at não pode mudar depois que o post foi enviado.
- Excluir postDELETEExclui um rascunho de forma definitiva, ou arquiva um post confirmado.
- Obter estatísticas agregadas de postsGETRetorna as estatísticas somadas dos posts de uma publicação que correspondem aos filtros: destinatários de email, entregas, aberturas, cliques, taxas, cancelamentos e denúncias de spam, visualizações e cliques na web e os links mais clicados. Em publicações grandes os números atualizam cerca de uma vez por hora, como mostra computed_at.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
