Crear suscripción en beehiiv, con una API

Suscribe un email a una publicación y devuelve la suscripción con su id. Con double opt-in en la publicación, o double_opt_override activado, la persona confirma por email antes de quedar activa.

Identificador
beehiiv_create_subscription

La llamada

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

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
publicationIdstringSíId of the publication, from List publications.
emailstringSíEmail address of the subscriber.
reactivate_existingbooleanNotrue subscribes again an email that had unsubscribed. Use it only when the person is knowingly subscribing again.
send_welcome_emailbooleanNotrue sends the welcome email of the publication.
double_opt_overridestringNoon asks for confirmation by email, off activates right away, not_set follows the setting of the publication.Valores: on, off, not_set
tierstringNoTier of the subscription.Valores: free, premium
premium_tiersarrayNoNames of the premium tiers to assign, as shown in beehiiv. Takes precedence over tier.
utm_sourcestringNoSource of the subscription.
utm_mediumstringNoMedium of the subscription.
utm_campaignstringNoAcquisition campaign of the subscription.
utm_termstringNoAcquisition term, usually the keyword.
utm_contentstringNoAcquisition content, usually the ad or A/B variation.
referring_sitestringNoWebsite the subscriber came from.
referral_codestringNoreferral_code of the subscriber who referred this one, which gives them the referral credit.
custom_fieldsarrayNoValues of custom fields that already exist in the publication, by field name. Unknown names are discarded.

Conexiones posibles

Tu cliente conecta su cuenta de beehiiv una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/beehiiv_create_subscription. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de beehiiv

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.