Criar assinatura no beehiiv, por uma API
Inscreve 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.
- Identificador
- beehiiv_create_subscription
A chamada
POST https://connect.reportei.com/api/tools/beehiiv_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"publicationId": "<publicationId>",
"email": "<email>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| publicationId | string | Sim | Id of the publication, from List publications. |
| string | Sim | Email address of the subscriber. | |
| reactivate_existing | boolean | Não | true subscribes again an email that had unsubscribed. Use it only when the person is knowingly subscribing again. |
| send_welcome_email | boolean | Não | true sends the welcome email of the publication. |
| double_opt_override | string | Não | on asks for confirmation by email, off activates right away, not_set follows the setting of the publication.Valores: on, off, not_set |
| tier | string | Não | Tier of the subscription.Valores: free, premium |
| premium_tiers | array | Não | Names of the premium tiers to assign, as shown in beehiiv. Takes precedence over tier. |
| utm_source | string | Não | Source of the subscription. |
| utm_medium | string | Não | Medium of the subscription. |
| utm_campaign | string | Não | Acquisition campaign of the subscription. |
| utm_term | string | Não | Acquisition term, usually the keyword. |
| utm_content | string | Não | Acquisition content, usually the ad or A/B variation. |
| referring_site | string | Não | Website the subscriber came from. |
| referral_code | string | Não | referral_code of the subscriber who referred this one, which gives them the referral credit. |
| custom_fields | array | Não | Values of custom fields that already exist in the publication, by field name. Unknown names are discarded. |
Conexões possíveis
O seu cliente conecta a conta do beehiiv uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/beehiiv_create_subscription. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do beehiiv
- 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.
- 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
