ConvertKit (publicador independiente)
ConvertKit es el centro de marketing de go-to para creadores que le ayuda a crecer y monetizar a su público con facilidad. Convierta sus seguidores de redes sociales, YouTube y mucho más en su lista de correo electrónico con una hermosa página de aterrizaje y plantillas de participación.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Correo Electrónico | ttaylor@hitachisolutions.com |
| Metadatos del conector | |
|---|---|
| Publicador | Troy Taylor, Hitachi Solutions |
| Sitio web | https://convertkit.com/ |
| Directiva de privacidad | https://convertkit.com/privacy |
| Categorías | Mercadotecnia |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Secreto de API | securestring | Secreto de API para esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar suscriptor |
Actualiza la información de un solo suscriptor. |
| Actualizar una difusión |
Actualiza los atributos de una difusión específica. Es posible que no se actualicen las difusiones que se envían actualmente o que se han enviado. |
| Agregar suscriptor a un formulario |
Suscríbase una dirección de correo electrónico a uno de los formularios. |
| Agregar suscriptor a una secuencia |
Suscríbase una dirección de correo electrónico a una de sus secuencias. |
| Creación de una compra |
Cree una compra. |
| Creación de una difusión |
Cree un borrador o una difusión programada. Puede crear una difusión de borrador sin ningún atributo. Las difusiones programadas como mínimo deben contener una línea de asunto y el contenido. |
| Creación de una etiqueta |
Crea una nueva etiqueta. |
| Destruir una difusión |
Elimine permanentemente un borrador o un registro de difusión programado. Es posible que no se eliminen las difusiones que se envían actualmente o que se han enviado. |
| Enumeración de difusión |
Recupera una lista de todas las difusiones de la cuenta. |
| Enumeración de suscripciones a un formulario |
Recupera una lista de suscripciones a un formulario, incluidos los datos del suscriptor. |
| Enumeración de suscripciones a una etiqueta |
Recupera una lista de suscripciones a una etiqueta, incluidos los datos del suscriptor. |
| Enumeración de suscripciones a una secuencia |
Recupera suscripciones a una secuencia que incluye los datos del suscriptor. |
| Enumerar compras |
Recupera una lista de todas las compras de una cuenta. |
| Enumerar las etiquetas del suscriptor |
Recupera una lista de todas las etiquetas de un suscriptor. |
| Enumerar secuencias |
Recupera una lista de secuencias de la cuenta. |
| Enumerar suscriptores |
Devuelve una lista de los suscriptores. Solo para las cancelaciones de suscripción, use el valor cancelado para el parámetro de campo de ordenación (actualmente el único campo de ordenación adicional admitido). |
| Etiquetar un suscriptor |
Las etiquetas se controlan como suscripciones. Suscríbase una dirección de correo electrónico a una etiqueta para que esa etiqueta se aplique al suscriptor con esa dirección de correo electrónico. |
| Etiquetas de lista |
Recupera una lista de etiquetas para la cuenta. |
| Obtención de estadísticas de difusión |
Recupera las estadísticas (recuento de destinatarios, tasa de apertura, tasa de clics, recuento de cancelaciones de suscripción, clics totales, estado y progreso de envío) para una difusión específica. |
| Obtener cuenta |
Recupera la cuenta actual. |
| Obtener formularios |
Recupere una lista de todos los formularios de la cuenta. |
| Obtener un suscriptor |
Recupera un único registro de suscriptor. |
| Obtener una compra |
Recuperar una compra específica por identificador. |
| Quitar etiqueta del suscriptor |
Quita una etiqueta de un suscriptor. |
| Quitar etiqueta del suscriptor por correo electrónico |
Quite una etiqueta de un suscriptor por dirección de correo electrónico. |
| Recuperar una difusión |
Recupera los detalles de una difusión específica, incluidas las difusión de borrador, programadas y enviadas previamente. |
| Suscripción al suscriptor |
Cancela la suscripción de un suscriptor de todos los formularios y secuencias. |
Actualizar suscriptor
Actualiza la información de un solo suscriptor.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de suscriptor
|
subscriber_id | True | string |
Identificador único del suscriptor. |
|
Nombre
|
first_name | string |
Nombre. |
|
|
Dirección de correo electrónico
|
email_address | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
subscriber.id | integer |
Identificador único. |
|
Nombre
|
subscriber.first_name | string |
Nombre. |
|
Dirección de correo electrónico
|
subscriber.email_address | string |
Dirección de correo electrónico. |
|
Estado
|
subscriber.state | string |
El estado. |
|
Creado en
|
subscriber.created_at | string |
Cuando se crea en . |
Actualizar una difusión
Actualiza los atributos de una difusión específica. Es posible que no se actualicen las difusiones que se envían actualmente o que se han enviado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de difusión
|
broadcast_id | True | string |
Identificador único de difusión. |
|
Description
|
description | string |
Descripción. |
|
|
Asunto
|
subject | string |
El asunto. |
|
|
Content
|
content | string |
El contenido. |
|
|
Dirección de correo electrónico
|
email_address | string |
Dirección de correo electrónico. |
|
|
Plantilla de diseño de correo electrónico
|
email_layout_template | string |
Plantilla de diseño de correo electrónico. |
|
|
Público
|
public | boolean |
Si es público. |
|
|
Publicado en
|
published_at | string |
Cuando se publica en . |
|
|
Enviar en
|
send_at | string |
Cuando se envía. |
|
|
Alt miniatura
|
thumbnail_alt | string |
Texto alternativo de la miniatura. |
|
|
Url de miniatura
|
thumbnail_url | string |
Dirección URL de la miniatura. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
broadcast.id | integer |
Identificador único. |
|
Creado en
|
broadcast.created_at | string |
Cuando se crea en . |
|
Asunto
|
broadcast.subject | string |
El asunto. |
|
Description
|
broadcast.description | string |
Descripción. |
|
Content
|
broadcast.content | string |
El contenido. |
|
Público
|
broadcast.public | boolean |
Si es público. |
|
Publicado en
|
broadcast.published_at | string |
Cuando se publica en . |
|
Enviar en
|
broadcast.send_at | string |
Cuando se envía. |
|
Alt miniatura
|
broadcast.thumbnail_alt | string |
Texto alternativo de la miniatura. |
|
Url de miniatura
|
broadcast.thumbnail_url | string |
Dirección URL de miniatura. |
|
Dirección de correo electrónico
|
broadcast.email_address | string |
Dirección de correo electrónico. |
|
Plantilla de diseño de correo electrónico
|
broadcast.email_layout_template | string |
Plantilla de diseño de correo electrónico. |
Agregar suscriptor a un formulario
Suscríbase una dirección de correo electrónico a uno de los formularios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de formulario
|
form_id | True | string |
Identificador único del formulario. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
|
|
Nombre
|
first_name | string |
Nombre. |
|
|
Etiquetas
|
tags | array of integer |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
subscription.id | integer |
Identificador único. |
|
Estado
|
subscription.state | string |
El estado. |
|
Creado en
|
subscription.created_at | string |
Cuando se crea en . |
|
Fuente
|
subscription.source | string |
Origen. |
|
Origen de referencia
|
subscription.referrer | string |
El remitente. |
|
Id. de suscripción
|
subscription.subscribable_id | integer |
Identificador único que se puede suscribir. |
|
Tipo de suscripción
|
subscription.subscribable_type | string |
Tipo que se puede suscribir. |
|
identificación
|
subscription.subscriber.id | integer |
Identificador único. |
|
Nombre
|
subscription.subscriber.first_name | string |
Nombre. |
|
Dirección de correo electrónico
|
subscription.subscriber.email_address | string |
Dirección de correo electrónico. |
|
Estado
|
subscription.subscriber.state | string |
El estado. |
|
Creado en
|
subscription.subscriber.created_at | string |
Cuando se crea en . |
Agregar suscriptor a una secuencia
Suscríbase una dirección de correo electrónico a una de sus secuencias.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de secuencia
|
sequence_id | True | string |
Identificador único de secuencia. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
|
|
Nombre
|
first_name | string |
Nombre. |
|
|
Etiquetas
|
tags | array of integer |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
subscription.id | integer |
Identificador único. |
|
Estado
|
subscription.state | string |
El estado. |
|
Creado en
|
subscription.created_at | string |
Cuando se crea en . |
|
Fuente
|
subscription.source | string |
Origen. |
|
Origen de referencia
|
subscription.referrer | string |
El remitente. |
|
Id. de suscripción
|
subscription.subscribable_id | integer |
Identificador único que se puede suscribir. |
|
Tipo de suscripción
|
subscription.subscribable_type | string |
Tipo que se puede suscribir. |
|
identificación
|
subscription.subscriber.id | integer |
Identificador único. |
Creación de una compra
Cree una compra.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de transacción
|
transaction_id | True | string |
Identificador único de transacción. |
|
Dirección de correo electrónico
|
email_address | True | string |
Dirección de correo electrónico. |
|
Nombre
|
first_name | string |
Nombre. |
|
|
Moneda
|
currency | True | string |
Moneda. |
|
Tiempo de transacción
|
transaction_time | string |
Tiempo de transacción. |
|
|
Subtotal
|
subtotal | integer |
Subtotal. |
|
|
Impuestos
|
tax | integer |
El impuesto. |
|
|
Naviero
|
shipping | integer |
El envío. |
|
|
Descuento
|
discount | integer |
El descuento. |
|
|
Total
|
total | integer |
Total. |
|
|
Estado
|
status | string |
Estado. |
|
|
PID
|
pid | True | integer |
Identificador personal. |
|
TAPA
|
lid | True | integer |
El LID. |
|
Nombre
|
name | True | string |
Nombre. |
|
SKU
|
sku | string |
El SKU. |
|
|
Precio por unidad
|
unit_price | True | integer |
Precio unitario. |
|
Cantidad
|
quantity | True | integer |
Cantidad. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | integer |
Identificador único. |
|
Id. de transacción
|
transaction_id | string |
Identificador único de transacción. |
|
Estado
|
status | string |
Estado. |
|
Dirección de correo electrónico
|
email_address | string |
Dirección de correo electrónico. |
|
Moneda
|
currency | string |
Moneda. |
|
Tiempo de transacción
|
transaction_time | string |
Tiempo de transacción. |
|
Subtotal
|
subtotal | integer |
Subtotal. |
|
Descuento
|
discount | integer |
El descuento. |
|
Impuestos
|
tax | integer |
El impuesto. |
|
Naviero
|
shipping | integer |
El envío. |
|
Total
|
total | integer |
Total. |
|
Products
|
products | array of object | |
|
Precio por unidad
|
products.unit_price | integer |
Precio unitario. |
|
Cantidad
|
products.quantity | integer |
Cantidad. |
|
SKU
|
products.sku | string |
El SKU. |
|
Nombre
|
products.name | string |
Nombre. |
Creación de una difusión
Cree un borrador o una difusión programada. Puede crear una difusión de borrador sin ningún atributo. Las difusiones programadas como mínimo deben contener una línea de asunto y el contenido.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Description
|
description | string |
Descripción. |
|
|
Asunto
|
subject | string |
El asunto. |
|
|
Content
|
content | string |
El contenido. |
|
|
Dirección de correo electrónico
|
email_address | string |
Dirección de correo electrónico. |
|
|
Plantilla de diseño de correo electrónico
|
email_layout_template | string |
Plantilla de diseño de correo electrónico. |
|
|
Público
|
public | boolean |
Si es público. |
|
|
Publicado en
|
published_at | string |
Cuando se publica en . |
|
|
Enviar en
|
send_at | string |
Cuando se envía. |
|
|
Alt miniatura
|
thumbnail_alt | string |
Texto alternativo de la miniatura. |
|
|
Url de miniatura
|
thumbnail_url | string |
Dirección URL de la miniatura. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
broadcast.id | integer |
Identificador único. |
|
Creado en
|
broadcast.created_at | string |
Cuando se crea en . |
|
Asunto
|
broadcast.subject | string |
El asunto. |
|
Description
|
broadcast.description | string |
Descripción. |
|
Content
|
broadcast.content | string |
El contenido. |
|
Público
|
broadcast.public | boolean |
Si es público. |
|
Publicado en
|
broadcast.published_at | string |
Cuando se publica en . |
|
Enviar en
|
broadcast.send_at | string |
Cuando se envía. |
|
Alt miniatura
|
broadcast.thumbnail_alt | string |
Texto alternativo de la miniatura. |
|
Url de miniatura
|
broadcast.thumbnail_url | string |
Dirección URL de miniatura. |
|
Dirección de correo electrónico
|
broadcast.email_address | string |
Dirección de correo electrónico. |
|
Plantilla de diseño de correo electrónico
|
broadcast.email_layout_template | string |
Plantilla de diseño de correo electrónico. |
Creación de una etiqueta
Crea una nueva etiqueta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
name | True | string |
Nombre. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de cuenta
|
account_id | integer |
Identificador único de la cuenta. |
|
Creado en
|
created_at | string |
Cuando se crea en . |
|
Eliminado en
|
deleted_at | string |
Cuando se elimina. |
|
identificación
|
id | integer |
Identificador único. |
|
Nombre
|
name | string |
Nombre. |
|
Estado
|
state | string |
El estado. |
|
Actualizado en
|
updated_at | string |
Cuando se actualiza en . |
Destruir una difusión
Elimine permanentemente un borrador o un registro de difusión programado. Es posible que no se eliminen las difusiones que se envían actualmente o que se han enviado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de difusión
|
broadcast_id | True | string |
Identificador único de difusión. |
Devoluciones
- response
- string
Enumeración de difusión
Recupera una lista de todas las difusiones de la cuenta.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Emisiones
|
broadcasts | array of object | |
|
identificación
|
broadcasts.id | integer |
Identificador único. |
|
Creado en
|
broadcasts.created_at | string |
Cuando se crea en . |
|
Asunto
|
broadcasts.subject | string |
El asunto. |
Enumeración de suscripciones a un formulario
Recupera una lista de suscripciones a un formulario, incluidos los datos del suscriptor.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de formulario
|
form_id | True | string |
Identificador único del formulario. |
|
Criterio de ordenación
|
sort_order | string |
Criterio de ordenación. |
|
|
Estado del suscriptor
|
subscriber_state | string |
Estado del suscriptor. |
|
|
Página
|
page | integer |
La página. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Total de suscripciones
|
total_subscriptions | integer |
Total de suscripciones. |
|
Página
|
page | integer |
La página. |
|
Total de páginas
|
total_pages | integer |
El total de páginas. |
|
Suscripciones
|
subscriptions | array of object | |
|
identificación
|
subscriptions.id | integer |
Identificador único. |
|
Estado
|
subscriptions.state | string |
El estado. |
|
Creado en
|
subscriptions.created_at | string |
Cuando se crea en . |
|
Fuente
|
subscriptions.source | string |
Origen. |
|
Origen de referencia
|
subscriptions.referrer | string |
El remitente. |
|
Id. de suscripción
|
subscriptions.subscribable_id | integer |
Identificador único que se puede suscribir. |
|
Tipo de suscripción
|
subscriptions.subscribable_type | string |
Tipo que se puede suscribir. |
|
identificación
|
subscriptions.subscriber.id | integer |
Identificador único. |
|
Nombre
|
subscriptions.subscriber.first_name | string |
Nombre. |
|
Dirección de correo electrónico
|
subscriptions.subscriber.email_address | string |
Dirección de correo electrónico. |
|
Estado
|
subscriptions.subscriber.state | string |
El estado. |
|
Creado en
|
subscriptions.subscriber.created_at | string |
Cuando se crea en . |
|
Apellido
|
subscriptions.subscriber.fields.last_name | string |
Apellidos. |
Enumeración de suscripciones a una etiqueta
Recupera una lista de suscripciones a una etiqueta, incluidos los datos del suscriptor.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de etiqueta
|
tag_id | True | string |
Identificador único de etiqueta. |
|
Criterio de ordenación
|
sort_order | string |
Criterio de ordenación. |
|
|
Estado del suscriptor
|
subscriber_state | string |
Estado del suscriptor. |
|
|
Página
|
page | integer |
La página. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Total de suscripciones
|
total_subscriptions | integer |
Total de suscripciones. |
|
Página
|
page | integer |
La página. |
|
Total de páginas
|
total_pages | integer |
El total de páginas. |
|
Suscripciones
|
subscriptions | array of object | |
|
identificación
|
subscriptions.id | integer |
Identificador único. |
|
Estado
|
subscriptions.state | string |
El estado. |
|
Creado en
|
subscriptions.created_at | string |
Cuando se crea en . |
|
Fuente
|
subscriptions.source | string |
Origen. |
|
Origen de referencia
|
subscriptions.referrer | string |
El remitente. |
|
Id. de suscripción
|
subscriptions.subscribable_id | integer |
Identificador único que se puede suscribir. |
|
Tipo de suscripción
|
subscriptions.subscribable_type | string |
Tipo que se puede suscribir. |
|
identificación
|
subscriptions.subscriber.id | integer |
Identificador único. |
|
Nombre
|
subscriptions.subscriber.first_name | string |
Nombre. |
|
Dirección de correo electrónico
|
subscriptions.subscriber.email_address | string |
Dirección de correo electrónico. |
|
Estado
|
subscriptions.subscriber.state | string |
El estado. |
|
Creado en
|
subscriptions.subscriber.created_at | string |
Cuando se crea en . |
|
Apellido
|
subscriptions.subscriber.fields.last_name | string |
Apellidos. |
Enumeración de suscripciones a una secuencia
Recupera suscripciones a una secuencia que incluye los datos del suscriptor.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de secuencia
|
sequence_id | True | string |
Identificador único de secuencia. |
|
Criterio de ordenación
|
sort_order | string |
Criterio de ordenación. |
|
|
Estado del suscriptor
|
subscriber_state | string |
Estado del suscriptor. |
|
|
Página
|
page | integer |
La página. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Total de suscripciones
|
total_subscriptions | integer |
Total de suscripciones. |
|
Página
|
page | integer |
La página. |
|
Total de páginas
|
total_pages | integer |
El total de páginas. |
|
Suscripciones
|
subscriptions | array of object | |
|
identificación
|
subscriptions.id | integer |
Identificador único. |
|
Estado
|
subscriptions.state | string |
El estado. |
|
Creado en
|
subscriptions.created_at | string |
Cuando se crea en . |
|
Fuente
|
subscriptions.source | string |
Origen. |
|
Origen de referencia
|
subscriptions.referrer | string |
El remitente. |
|
Id. de suscripción
|
subscriptions.subscribable_id | integer |
Identificador único que se puede suscribir. |
|
Tipo de suscripción
|
subscriptions.subscribable_type | string |
Tipo que se puede suscribir. |
|
identificación
|
subscriptions.subscriber.id | integer |
Identificador único. |
|
Nombre
|
subscriptions.subscriber.first_name | string |
Nombre. |
|
Dirección de correo electrónico
|
subscriptions.subscriber.email_address | string |
Dirección de correo electrónico. |
|
Estado
|
subscriptions.subscriber.state | string |
El estado. |
|
Creado en
|
subscriptions.subscriber.created_at | string |
Cuando se crea en . |
|
Apellido
|
subscriptions.subscriber.fields.last_name | string |
Apellidos. |
Enumerar compras
Recupera una lista de todas las compras de una cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
La página. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Total de compras
|
total_purchases | integer |
El total de compras. |
|
Página
|
page | integer |
La página. |
|
Total de páginas
|
total_pages | integer |
El total de páginas. |
|
Compras
|
purchases | array of object | |
|
identificación
|
purchases.id | integer |
Identificador único. |
|
Id. de transacción
|
purchases.transaction_id | string |
Identificador único de transacción. |
|
Estado
|
purchases.status | string |
Estado. |
|
Dirección de correo electrónico
|
purchases.email_address | string |
Dirección de correo electrónico. |
|
Moneda
|
purchases.currency | string |
Moneda. |
|
Tiempo de transacción
|
purchases.transaction_time | string |
Tiempo de transacción. |
|
Subtotal
|
purchases.subtotal | integer |
Subtotal. |
|
Naviero
|
purchases.shipping | integer |
El envío. |
|
Descuento
|
purchases.discount | integer |
El descuento. |
|
Impuestos
|
purchases.tax | integer |
El impuesto. |
|
Total
|
purchases.total | integer |
Total. |
|
Products
|
purchases.products | array of object | |
|
Precio por unidad
|
purchases.products.unit_price | integer |
Precio unitario. |
|
Cantidad
|
purchases.products.quantity | integer |
Cantidad. |
|
SKU
|
purchases.products.sku | string |
El SKU. |
|
Nombre
|
purchases.products.name | string |
Nombre. |
Enumerar las etiquetas del suscriptor
Recupera una lista de todas las etiquetas de un suscriptor.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de suscriptor
|
subscriber_id | True | string |
Identificador único del suscriptor. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Etiquetas
|
tags | array of object | |
|
identificación
|
tags.id | integer |
Identificador único. |
|
Nombre
|
tags.name | string |
Nombre. |
|
Creado en
|
tags.created_at | string |
Cuando se crea en . |
Enumerar secuencias
Recupera una lista de secuencias de la cuenta.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Cursos
|
courses | array of object | |
|
identificación
|
courses.id | integer |
Identificador único. |
|
Nombre
|
courses.name | string |
Nombre. |
|
Creado en
|
courses.created_at | string |
Cuando se crea en . |
Enumerar suscriptores
Devuelve una lista de los suscriptores. Solo para las cancelaciones de suscripción, use el valor cancelado para el parámetro de campo de ordenación (actualmente el único campo de ordenación adicional admitido).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
De
|
from | string |
El de. |
|
|
Para
|
to | string |
el objeto al que. |
|
|
Actualizado desde
|
updated_from | string |
Cuando se actualiza desde. |
|
|
Actualizado a
|
updated_to | string |
Cuando se actualiza a. |
|
|
Criterio de ordenación
|
sort_order | string |
Criterio de ordenación. |
|
|
Ordenar campo
|
sort_field | string |
Campo de ordenación. |
|
|
Dirección de correo electrónico
|
email_address | string |
Dirección de correo electrónico. |
|
|
Página
|
page | integer |
La página. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Total de suscriptores
|
total_subscribers | integer |
El total de suscriptores. |
|
Página
|
page | integer |
La página. |
|
Total de páginas
|
total_pages | integer |
El total de páginas. |
|
Subscribers
|
subscribers | array of object | |
|
identificación
|
subscribers.id | integer |
Identificador único. |
|
Nombre
|
subscribers.first_name | string |
Nombre. |
|
Dirección de correo electrónico
|
subscribers.email_address | string |
Dirección de correo electrónico. |
|
Estado
|
subscribers.state | string |
El estado. |
|
Creado en
|
subscribers.created_at | string |
Cuando se crea en . |
|
Apellido
|
subscribers.fields.last_name | string |
Apellidos. |
Etiquetar un suscriptor
Las etiquetas se controlan como suscripciones. Suscríbase una dirección de correo electrónico a una etiqueta para que esa etiqueta se aplique al suscriptor con esa dirección de correo electrónico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de etiqueta
|
tag_id | True | string |
Identificador único de etiqueta. |
|
Correo Electrónico
|
string |
Dirección de correo electrónico. |
||
|
Nombre
|
first_name | string |
Nombre. |
|
|
Etiquetas
|
tags | array of integer |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
subscription.id | integer |
Identificador único. |
|
Estado
|
subscription.state | string |
El estado. |
|
Creado en
|
subscription.created_at | string |
Cuando se crea en . |
|
Fuente
|
subscription.source | string |
Origen. |
|
Origen de referencia
|
subscription.referrer | string |
El remitente. |
|
Id. de suscripción
|
subscription.subscribable_id | integer |
Identificador único que se puede suscribir. |
|
Tipo de suscripción
|
subscription.subscribable_type | string |
Tipo que se puede suscribir. |
|
identificación
|
subscription.subscriber.id | integer |
Identificador único. |
Etiquetas de lista
Recupera una lista de etiquetas para la cuenta.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Etiquetas
|
tags | array of object | |
|
identificación
|
tags.id | integer |
Identificador único. |
|
Nombre
|
tags.name | string |
Nombre. |
|
Creado en
|
tags.created_at | string |
Cuando se crea en . |
Obtención de estadísticas de difusión
Recupera las estadísticas (recuento de destinatarios, tasa de apertura, tasa de clics, recuento de cancelaciones de suscripción, clics totales, estado y progreso de envío) para una difusión específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de difusión
|
broadcast_id | True | string |
Identificador único de difusión. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Emisión
|
broadcast | array of object | |
|
identificación
|
broadcast.id | integer |
Identificador único. |
|
Recipientes
|
broadcast.stats.recipients | integer |
Destinatarios. |
|
Tasa de apertura
|
broadcast.stats.open_rate | float |
Tasa de apertura. |
|
Frecuencia de clics
|
broadcast.stats.click_rate | float |
Frecuencia de clic. |
|
Anulaciones de suscripción
|
broadcast.stats.unsubscribes | integer |
Cancela la suscripción. |
|
Total de clics
|
broadcast.stats.total_clicks | integer |
El total de clics. |
|
Mostrar clics totales
|
broadcast.stats.show_total_clicks | boolean |
Indica si se muestran los clics totales. |
|
Estado
|
broadcast.stats.status | string |
Estado. |
|
Progress
|
broadcast.stats.progress | integer |
Progreso. |
Obtener cuenta
Recupera la cuenta actual.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
name | string |
Nombre. |
|
Tipo de plan
|
plan_type | string |
Tipo de plan. |
|
Dirección de correo electrónico principal
|
primary_email_address | string |
Dirección de correo electrónico principal. |
Obtener formularios
Recupere una lista de todos los formularios de la cuenta.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Formularios
|
forms | array of object | |
|
identificación
|
forms.id | integer |
Identificador único. |
|
Nombre
|
forms.name | string |
Nombre. |
|
Creado en
|
forms.created_at | string |
Cuando se crea en . |
|
Tipo
|
forms.type | string |
Tipo. |
|
Formato
|
forms.format | string |
El formato. |
|
URL
|
forms.url | string |
Dirección URL. |
|
Inserción de JS
|
forms.embed_js | string |
JavaScript que se va a insertar. |
|
Insertar dirección URL
|
forms.embed_url | string |
Dirección URL que se va a insertar. |
|
Title
|
forms.title | string |
Título. |
|
Description
|
forms.description | string |
Descripción. |
|
Texto del botón de registro
|
forms.sign_up_button_text | string |
Texto del botón de registro. |
|
Mensaje de operación correcta
|
forms.success_message | string |
Mensaje de operación correcta. |
|
Archivado
|
forms.archived | boolean |
Si está archivado. |
|
UID
|
forms.uid | string |
Identificador único. |
Obtener un suscriptor
Recupera un único registro de suscriptor.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de suscriptor
|
subscriber_id | True | string |
Identificador único del suscriptor. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
subscriber.id | integer |
Identificador único. |
|
Nombre
|
subscriber.first_name | string |
Nombre. |
|
Dirección de correo electrónico
|
subscriber.email_address | string |
Dirección de correo electrónico. |
|
Estado
|
subscriber.state | string |
El estado. |
|
Creado en
|
subscriber.created_at | string |
Cuando se crea en . |
|
Apellido
|
subscriber.fields.last_name | string |
Apellidos. |
Obtener una compra
Recuperar una compra específica por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de compra
|
purchase_id | True | string |
Identificador de compra. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | integer |
Identificador único. |
|
Id. de transacción
|
transaction_id | string |
Identificador único de transacción. |
|
Estado
|
status | string |
Estado. |
|
Dirección de correo electrónico
|
email_address | string |
Dirección de correo electrónico. |
|
Moneda
|
currency | string |
Moneda. |
|
Tiempo de transacción
|
transaction_time | string |
Tiempo de transacción. |
|
Subtotal
|
subtotal | integer |
Subtotal. |
|
Naviero
|
shipping | integer |
El envío. |
|
Descuento
|
discount | integer |
El descuento. |
|
Impuestos
|
tax | integer |
El impuesto. |
|
Total
|
total | integer |
Total. |
|
Products
|
products | array of object | |
|
Precio por unidad
|
products.unit_price | integer |
Precio unitario. |
|
Cantidad
|
products.quantity | integer |
Cantidad. |
|
SKU
|
products.sku | string |
El SKU. |
|
Nombre
|
products.name | string |
Nombre. |
Quitar etiqueta del suscriptor
Quita una etiqueta de un suscriptor.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de suscriptor
|
subscriber_id | True | string |
Identificador único del suscriptor. |
|
Identificador de etiqueta
|
tag_id | True | string |
Identificador único de etiqueta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | integer |
Identificador único. |
|
Nombre
|
name | string |
Nombre. |
|
Creado en
|
created_at | string |
Cuando se crea en . |
Quitar etiqueta del suscriptor por correo electrónico
Quite una etiqueta de un suscriptor por dirección de correo electrónico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de etiqueta
|
tag_id | True | string |
Identificador único de etiqueta. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | integer |
Identificador único. |
|
Nombre
|
name | string |
Nombre. |
|
Creado en
|
created_at | string |
Cuando se crea en . |
Recuperar una difusión
Recupera los detalles de una difusión específica, incluidas las difusión de borrador, programadas y enviadas previamente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de difusión
|
broadcast_id | True | string |
Identificador único de difusión. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
broadcast.id | integer |
Identificador único. |
|
Creado en
|
broadcast.created_at | string |
Cuando se crea en . |
|
Asunto
|
broadcast.subject | string |
El asunto. |
|
Description
|
broadcast.description | string |
Descripción. |
|
Content
|
broadcast.content | string |
El contenido. |
|
Público
|
broadcast.public | boolean |
Si es público. |
|
Publicado en
|
broadcast.published_at | string |
Cuando se publica en . |
|
Enviar en
|
broadcast.send_at | string |
Cuando se envía. |
|
Alt miniatura
|
broadcast.thumbnail_alt | string |
Texto alternativo de la miniatura. |
|
Url de miniatura
|
broadcast.thumbnail_url | string |
Dirección URL de miniatura. |
|
Dirección de correo electrónico
|
broadcast.email_address | string |
Dirección de correo electrónico. |
|
Plantilla de diseño de correo electrónico
|
broadcast.email_layout_template | string |
Plantilla de diseño de correo electrónico. |
Suscripción al suscriptor
Cancela la suscripción de un suscriptor de todos los formularios y secuencias.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
subscriber.id | integer |
Identificador único. |
|
Nombre
|
subscriber.first_name | string |
Nombre. |
|
Dirección de correo electrónico
|
subscriber.email_address | string |
Dirección de correo electrónico. |
|
Estado
|
subscriber.state | string |
El estado. |
|
Creado en
|
subscriber.created_at | string |
Cuando se crea en . |
|
Apellido
|
subscriber.fields.last_name | string |
Apellidos. |
Definiciones
cuerda / cadena
Este es el tipo de datos básico "string".