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âmetroTipoObrigatórioDescrição
publicationIdstringSimId of the publication, from List publications.
emailstringSimEmail address of the subscriber.
reactivate_existingbooleanNãotrue subscribes again an email that had unsubscribed. Use it only when the person is knowingly subscribing again.
send_welcome_emailbooleanNãotrue sends the welcome email of the publication.
double_opt_overridestringNãoon asks for confirmation by email, off activates right away, not_set follows the setting of the publication.Valores: on, off, not_set
tierstringNãoTier of the subscription.Valores: free, premium
premium_tiersarrayNãoNames of the premium tiers to assign, as shown in beehiiv. Takes precedence over tier.
utm_sourcestringNãoSource of the subscription.
utm_mediumstringNãoMedium of the subscription.
utm_campaignstringNãoAcquisition campaign of the subscription.
utm_termstringNãoAcquisition term, usually the keyword.
utm_contentstringNãoAcquisition content, usually the ad or A/B variation.
referring_sitestringNãoWebsite the subscriber came from.
referral_codestringNãoreferral_code of the subscriber who referred this one, which gives them the referral credit.
custom_fieldsarrayNãoValues 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

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.