Mettre à jour un abonnement avec l'API beehiiv

Met à jour un abonnement. Seuls les champs envoyés changent. unsubscribe true désabonne la personne de la publication.

Identifiant
beehiiv_update_subscription

L'appel

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>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
publicationIdstringOuiId of the publication, from List publications.
subscriptionIdstringOuiId of the subscription, from List subscriptions.
emailstringNonNew email address of the subscriber.
tierstringNonNew tier of the subscription.Valeurs : free, premium
premium_tiersarrayNonNames of the premium tiers to assign, as shown in beehiiv.
unsubscribebooleanNontrue unsubscribes the person from the publication.
custom_fieldsarrayNonCustom field values to change, by field name. delete true removes the value of that field.

Connexions possibles

Votre client connecte son compte beehiiv une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/beehiiv_update_subscription. Il devient la définition de tool de votre agent sans conversion.

Autres tools beehiiv

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.