Atualizar assinatura no beehiiv, por uma API

Atualiza uma assinatura. Só os campos enviados mudam. unsubscribe true cancela a inscrição da pessoa na publicação.

Identificador
beehiiv_update_subscription

A chamada

POST https://connect.reportei.com/api/tools/beehiiv_update_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>",
    "subscriptionId": "<subscriptionId>"
  }
}

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.
subscriptionIdstringSimId of the subscription, from List subscriptions.
emailstringNãoNew email address of the subscriber.
tierstringNãoNew tier of the subscription.Valores: free, premium
premium_tiersarrayNãoNames of the premium tiers to assign, as shown in beehiiv.
unsubscribebooleanNãotrue unsubscribes the person from the publication.
custom_fieldsarrayNãoCustom field values to change, by field name. delete true removes the value of that field.

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_update_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.