Tools beehiiv
Les 12 opérations beehiiv que votre produit exécute sur le compte de votre client via Connect. Elles utilisent toutes le même endpoint, POST /api/tools/{tool}/execute.
- Lister les publicationsGETListe les publications accessibles avec la API key, avec id, name et organization_name. expand stats ajoute les abonnements actifs, les taux moyens d'ouverture et de clic et les totaux envoyés. Paginez avec page et limit, jusqu'à 100 ; la réponse contient total_pages.
- Lister les abonnementsGETListe les abonnements (abonnés) d'une publication, éventuellement pour un seul email, statut ou tier. Paginez avec limit, jusqu'à 100, et cursor : la réponse contient has_more et next_cursor.
- Obtenir un abonnementGETRenvoie un abonnement avec email, status, created, subscription_tier, les champs utm et referral_code.
- Créer un abonnementPOSTAbonne 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.
- Mettre à jour un abonnementPATCHMet à jour un abonnement. Seuls les champs envoyés changent. unsubscribe true désabonne la personne de la publication.
- Créer un tag d'abonnementPOSTAjoute des tags à un abonnement. Un tag qui n'existe pas encore dans la publication est créé.
- Lister les postsGETListe les posts d'une publication avec id, title, subtitle, status, publish_date et web_url. expand stats ajoute les statistiques email et web de chaque post. Paginez avec page et limit, jusqu'à 100 ; la réponse contient total_pages.
- Obtenir un postGETRenvoie un post ; expand stats ajoute ses statistiques email et web. Un post créé à l'instant peut répondre 202 pendant que beehiiv le construit, et 404 avec POST_CREATION_FAILED quand la création a échoué.
- Créer un postPOSTCrée un post à partir de HTML et renvoie son id ; uniquement sur les plans Pro et Enterprise. status draft, la valeur par défaut, l'enregistre seulement ; confirmed l'envoie et le publie tout de suite ou à scheduled_at. beehiiv construit le post en arrière-plan, donc Get post peut répondre 202 un instant.
- Mettre à jour un postPATCHMet à jour un post ; uniquement sur les plans Pro et Enterprise. Seuls les champs envoyés changent, et body_content remplace tout le contenu. scheduled_at ne peut plus changer une fois le post envoyé.
- Supprimer un postDELETESupprime définitivement un brouillon, ou archive un post confirmé.
- Obtenir les statistiques agrégées des postsGETRenvoie les statistiques cumulées des posts d'une publication qui correspondent aux filtres : destinataires d'email, livraisons, ouvertures, clics, taux, désabonnements et signalements de spam, vues et clics web et les liens les plus cliqués. Pour les grandes publications, les chiffres se rafraîchissent environ toutes les heures, comme l'indique computed_at.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
