Créer un abonnement avec l'API beehiiv

Abonne un email à une publication et renvoie l'abonnement avec son id. Avec le double opt-in sur la publication, ou double_opt_override activé, la personne confirme par email avant de devenir active.

Identifiant
beehiiv_create_subscription

L'appel

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

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.
emailstringOuiEmail address of the subscriber.
reactivate_existingbooleanNontrue subscribes again an email that had unsubscribed. Use it only when the person is knowingly subscribing again.
send_welcome_emailbooleanNontrue sends the welcome email of the publication.
double_opt_overridestringNonon asks for confirmation by email, off activates right away, not_set follows the setting of the publication.Valeurs : on, off, not_set
tierstringNonTier of the subscription.Valeurs : free, premium
premium_tiersarrayNonNames of the premium tiers to assign, as shown in beehiiv. Takes precedence over tier.
utm_sourcestringNonSource of the subscription.
utm_mediumstringNonMedium of the subscription.
utm_campaignstringNonAcquisition campaign of the subscription.
utm_termstringNonAcquisition term, usually the keyword.
utm_contentstringNonAcquisition content, usually the ad or A/B variation.
referring_sitestringNonWebsite the subscriber came from.
referral_codestringNonreferral_code of the subscriber who referred this one, which gives them the referral credit.
custom_fieldsarrayNonValues of custom fields that already exist in the publication, by field name. Unknown names are discarded.

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