Tools de beehiiv
Las 12 operaciones de beehiiv que tu producto ejecuta en la cuenta de tu cliente con Connect. Todas usan el mismo endpoint, POST /api/tools/{tool}/execute.
- Listar publicacionesGETLista las publicaciones a las que llega la API key, con id, name y organization_name. expand stats añade suscripciones activas, tasas medias de apertura y clic y totales enviados. Pagina con page y limit, hasta 100; la respuesta trae total_pages.
- Listar suscripcionesGETLista las suscripciones (suscriptores) de una publicación, opcionalmente solo de un email, estado o tier. Pagina con limit, hasta 100, y cursor: la respuesta trae has_more y next_cursor.
- Obtener suscripciónGETDevuelve una suscripción con email, status, created, subscription_tier, los campos utm y referral_code.
- Crear suscripciónPOSTSuscribe 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.
- Actualizar suscripciónPATCHActualiza una suscripción. Solo cambian los campos enviados. unsubscribe true da de baja a la persona de la publicación.
- Crear etiqueta de suscripciónPOSTAñade etiquetas a una suscripción. Una etiqueta que aún no existe en la publicación se crea.
- Listar postsGETLista los posts de una publicación con id, title, subtitle, status, publish_date y web_url. expand stats añade las estadísticas de email y web de cada post. Pagina con page y limit, hasta 100; la respuesta trae total_pages.
- Obtener postGETDevuelve un post; expand stats añade sus estadísticas de email y web. Un post creado hace un momento puede responder 202 mientras beehiiv lo construye, y 404 con POST_CREATION_FAILED cuando la creación falló.
- Crear postPOSTCrea un post a partir de HTML y devuelve su id; solo en los planes Pro y Enterprise. status draft, el valor por defecto, solo lo guarda; confirmed lo envía y publica de inmediato o en scheduled_at. beehiiv construye el post en segundo plano, así que Get post puede responder 202 por un momento.
- Actualizar postPATCHActualiza un post; solo en los planes Pro y Enterprise. Solo cambian los campos enviados, y body_content reemplaza todo el contenido. scheduled_at no puede cambiar después de enviado el post.
- Eliminar postDELETEElimina un borrador de forma definitiva, o archiva un post confirmado.
- Obtener estadísticas agregadas de postsGETDevuelve las estadísticas sumadas de los posts de una publicación que coinciden con los filtros: destinatarios de email, entregas, aperturas, clics, tasas, bajas y denuncias de spam, vistas y clics en la web y los enlaces más clicados. En publicaciones grandes los números se actualizan aproximadamente cada hora, como indica computed_at.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
