Actualizar suscripción en beehiiv, con una API

Actualiza una suscripción. Solo cambian los campos enviados. unsubscribe true da de baja a la persona de la publicación.

Identificador
beehiiv_update_subscription

La llamada

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

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.
subscriptionIdstringSíId of the subscription, from List subscriptions.
emailstringNoNew email address of the subscriber.
tierstringNoNew tier of the subscription.Valores: free, premium
premium_tiersarrayNoNames of the premium tiers to assign, as shown in beehiiv.
unsubscribebooleanNotrue unsubscribes the person from the publication.
custom_fieldsarrayNoCustom field values to change, by field name. delete true removes the value of that field.

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