Partilhar via

ConvertKit (Editora Independente)

O ConvertKit é o go-to hub de marketing para criadores que ajuda você a crescer e monetizar seu público com facilidade. Converta os seus seguidores das redes sociais, do YouTube e muito mais para a sua lista de e-mails com uma bela página de destino e modelos de aceitação.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troia Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Editora Troy Taylor, Soluções Hitachi
Sítio Web https://convertkit.com/
Política de privacidade https://convertkit.com/privacy
Categorias Marketing

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Segredo da API securestring O segredo da API para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar assinante a uma sequência

Subscreva um endereço de e-mail para uma das suas sequências.
Adicionar subscritor a um formulário

Subscreva um endereço de e-mail num dos seus formulários.
Atualizar assinante

Atualiza as informações de um único assinante.
Atualizar uma transmissão

Atualiza os atributos de uma transmissão específica. As transmissões que estão sendo enviadas no momento ou que foram enviadas podem não ser atualizadas.
Cancelar subscrição

Cancele a inscrição de um assinante de todos os seus formulários e sequências.
Criar uma compra

Crie uma compra.
Criar uma etiqueta

Cria uma nova tag.
Criar uma transmissão

Crie um rascunho ou uma transmissão agendada. Você pode criar uma transmissão de rascunho sem quaisquer atributos. As transmissões programadas, no mínimo, devem conter uma linha de assunto e o seu conteúdo.
Destruir uma transmissão

Exclua permanentemente um rascunho ou um registro de transmissão agendada. As transmissões que estão sendo enviadas no momento ou que foram enviadas não podem ser excluídas.
Lista de subscritores

Devolve uma lista dos seus subscritores. Apenas para cancelar inscrições, use o valor cancelado em para param de campo de classificação (atualmente o único campo de classificação extra suportado).
Listar assinaturas de um formulário

Recupera uma lista de assinaturas de um formulário, incluindo dados do assinante.
Listar assinaturas de uma sequência

Recupera assinaturas de uma sequência, incluindo dados do assinante.
Listar assinaturas de uma tag

Recupera uma lista de assinaturas de uma tag incluindo dados do assinante.
Listar compras

Recupere uma lista de todas as compras de uma conta.
Listar sequências

Recupera uma lista de sequências para a conta.
Listar tags de assinante

Recupera uma lista de todas as tags de um assinante.
Listar transmissões

Recupera uma lista de todas as transmissões da sua conta.
Marcar um assinante

As tags são tratadas como assinaturas. Inscreva um endereço de e-mail em uma tag para que essa tag seja aplicada ao assinante com esse endereço de e-mail.
Obter conta

Recupera a conta corrente.
Obter estatísticas de transmissão

Recupera as estatísticas (contagem de destinatários, taxa de abertura, taxa de cliques, contagem de cancelamento de inscrição, total de cliques, status e progresso de envio) de uma transmissão específica.
Obter formulários

Recupere uma lista de todos os formulários da sua conta.
Obter um subscritor

Recupera um único registro de assinante.
Obter uma compra

Recupere uma compra específica por ID.
Recuperar uma transmissão

Recupera os detalhes de uma transmissão específica, incluindo transmissões de rascunho, agendadas e enviadas anteriormente.
Remover tag do assinante

Remove uma tag de um assinante.
Remover tag do assinante por e-mail

Remova uma tag de um assinante por endereço de e-mail.
Tags de lista

Recupera uma lista de tags para a conta.

Adicionar assinante a uma sequência

ID da Operação:
SequenceSubAdd

Subscreva um endereço de e-mail para uma das suas sequências.

Parâmetros

Name Chave Necessário Tipo Description
ID da sequência
 sequence_id True string

O identificador exclusivo da sequência.
Email
 email True string

O endereço de e-mail.
Nome Próprio
 first_name string

O primeiro nome.
Etiquetas
 tags array of integer

Devoluções

Name Caminho Tipo Description
ID
 subscription.id integer

O identificador único.
Estado
 subscription.state string

O Estado.
Criado em
 subscription.created_at string

Quando criado em.
Fonte
 subscription.source string

A fonte.
Referenciador
 subscription.referrer string

O referenciador.
ID subscritível
 subscription.subscribable_id integer

O identificador único subscrito.
Tipo subscrito
 subscription.subscribable_type string

O tipo subscritível.
ID
 subscription.subscriber.id integer

O identificador único.

Adicionar subscritor a um formulário

ID da Operação:
FormSubAdd

Subscreva um endereço de e-mail num dos seus formulários.

Parâmetros

Name Chave Necessário Tipo Description
ID do formulário
 form_id True string

O identificador exclusivo do formulário.
Email
 email True string

O endereço de e-mail.
Nome Próprio
 first_name string

O primeiro nome.
Etiquetas
 tags array of integer

Devoluções

Name Caminho Tipo Description
ID
 subscription.id integer

O identificador único.
Estado
 subscription.state string

O Estado.
Criado em
 subscription.created_at string

Quando criado em.
Fonte
 subscription.source string

A fonte.
Referenciador
 subscription.referrer string

O referenciador.
ID subscritível
 subscription.subscribable_id integer

O identificador único subscrito.
Tipo subscrito
 subscription.subscribable_type string

O tipo subscritível.
ID
 subscription.subscriber.id integer

O identificador único.
Nome Próprio
 subscription.subscriber.first_name string

O primeiro nome.
Endereço de E-mail
 subscription.subscriber.email_address string

O endereço de e-mail.
Estado
 subscription.subscriber.state string

O Estado.
Criado em
 subscription.subscriber.created_at string

Quando criado em.

Atualizar assinante

ID da Operação:
SubscriberUpdate

Atualiza as informações de um único assinante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Assinante
 subscriber_id True string

O identificador exclusivo do assinante.
Nome Próprio
 first_name string

O primeiro nome.
Endereço de E-mail
 email_address string

O endereço de e-mail.

Devoluções

Name Caminho Tipo Description
ID
 subscriber.id integer

O identificador único.
Nome Próprio
 subscriber.first_name string

O primeiro nome.
Endereço de E-mail
 subscriber.email_address string

O endereço de e-mail.
Estado
 subscriber.state string

O Estado.
Criado em
 subscriber.created_at string

Quando criado em.

Atualizar uma transmissão

ID da Operação:
BroadcastUpdate

Atualiza os atributos de uma transmissão específica. As transmissões que estão sendo enviadas no momento ou que foram enviadas podem não ser atualizadas.

Parâmetros

Name Chave Necessário Tipo Description
ID de transmissão
 broadcast_id True string

O identificador exclusivo de transmissão.
Description
 description string

A descrição.
Assunto
 subject string

O assunto.
Content
 content string

O conteúdo.
Endereço de E-mail
 email_address string

O endereço de e-mail.
Modelo de layout de e-mail
 email_layout_template string

O modelo de layout de e-mail.
Public
 public boolean

Se público.
Publicado em
 published_at string

Quando publicado em.
Enviar em
 send_at string

Quando enviar em.
Miniatura Alt
 thumbnail_alt string

O texto alternativo para a miniatura.
URL da miniatura
 thumbnail_url string

O endereço URL da miniatura.

Devoluções

Name Caminho Tipo Description
ID
 broadcast.id integer

O identificador único.
Criado em
 broadcast.created_at string

Quando criado em.
Assunto
 broadcast.subject string

O assunto.
Description
 broadcast.description string

A descrição.
Content
 broadcast.content string

O conteúdo.
Public
 broadcast.public boolean

Se público.
Publicado em
 broadcast.published_at string

Quando publicado em.
Enviar em
 broadcast.send_at string

Quando enviado em.
Miniatura Alt
 broadcast.thumbnail_alt string

O texto alternativo para a miniatura.
URL da miniatura
 broadcast.thumbnail_url string

O endereço URL da miniatura.
Endereço de E-mail
 broadcast.email_address string

O endereço de e-mail.
Modelo de layout de e-mail
 broadcast.email_layout_template string

O modelo de layout de e-mail.

Cancelar subscrição

ID da Operação:
SubscriberUnsub

Cancele a inscrição de um assinante de todos os seus formulários e sequências.

Parâmetros

Name Chave Necessário Tipo Description
Email
 email True string

O endereço de e-mail.

Devoluções

Name Caminho Tipo Description
ID
 subscriber.id integer

O identificador único.
Nome Próprio
 subscriber.first_name string

O primeiro nome.
Endereço de E-mail
 subscriber.email_address string

O endereço de e-mail.
Estado
 subscriber.state string

O Estado.
Criado em
 subscriber.created_at string

Quando criado em.
Apelido
 subscriber.fields.last_name string

O sobrenome.

Criar uma compra

ID da Operação:
PurchaseAdd

Crie uma compra.

Parâmetros

Name Chave Necessário Tipo Description
ID da transação
 transaction_id True string

O identificador exclusivo da transação.
Endereço de E-mail
 email_address True string

O endereço de e-mail.
Nome Próprio
 first_name string

O primeiro nome.
Moeda
 currency True string

A moeda.
Tempo de Transação
 transaction_time string

O tempo da transação.
Subtotal
 subtotal integer

O subtotal.
Imposto
 tax integer

O imposto.
Envio
 shipping integer

O envio.
Desconto
 discount integer

O desconto.
Total
 total integer

O total.
Situação
 status string

O status.
PID
 pid True integer

O identificador pessoal.
LID
 lid True integer

A TAMPA.
Nome
 name True string

O nome.
SKU
 sku string

O SKU.
Preço por Unidade
 unit_price True integer

O preço unitário.
Quantidade
 quantity True integer

A quantidade.

Devoluções

Name Caminho Tipo Description
ID
 id integer

O identificador único.
ID da transação
 transaction_id string

O identificador exclusivo da transação.
Situação
 status string

O status.
Endereço de E-mail
 email_address string

O endereço de e-mail.
Moeda
 currency string

A moeda.
Tempo de Transação
 transaction_time string

O tempo da transação.
Subtotal
 subtotal integer

O subtotal.
Desconto
 discount integer

O desconto.
Imposto
 tax integer

O imposto.
Envio
 shipping integer

O envio.
Total
 total integer

O total.
Products
 products array of object
Preço por Unidade
 products.unit_price integer

O preço unitário.
Quantidade
 products.quantity integer

A quantidade.
SKU
 products.sku string

O SKU.
Nome
 products.name string

O nome.

Criar uma etiqueta

ID da Operação:
TagAdd

Cria uma nova tag.

Parâmetros

Name Chave Necessário Tipo Description
Nome
 name True string

O nome.

Devoluções

Name Caminho Tipo Description
ID da conta
 account_id integer

O identificador exclusivo da conta.
Criado em
 created_at string

Quando criado em.
Suprimido em
 deleted_at string

Quando excluído em.
ID
 id integer

O identificador único.
Nome
 name string

O nome.
Estado
 state string

O Estado.
Atualizado em
 updated_at string

Quando atualizado em.

Criar uma transmissão

ID da Operação:
BroadcastAdd

Crie um rascunho ou uma transmissão agendada. Você pode criar uma transmissão de rascunho sem quaisquer atributos. As transmissões programadas, no mínimo, devem conter uma linha de assunto e o seu conteúdo.

Parâmetros

Name Chave Necessário Tipo Description
Description
 description string

A descrição.
Assunto
 subject string

O assunto.
Content
 content string

O conteúdo.
Endereço de E-mail
 email_address string

O endereço de e-mail.
Modelo de layout de e-mail
 email_layout_template string

O modelo de layout de e-mail.
Public
 public boolean

Se público.
Publicado em
 published_at string

Quando publicado em.
Enviar em
 send_at string

Quando enviar em.
Miniatura Alt
 thumbnail_alt string

O texto alternativo para a miniatura.
URL da miniatura
 thumbnail_url string

O endereço URL da miniatura.

Devoluções

Name Caminho Tipo Description
ID
 broadcast.id integer

O identificador único.
Criado em
 broadcast.created_at string

Quando criado em.
Assunto
 broadcast.subject string

O assunto.
Description
 broadcast.description string

A descrição.
Content
 broadcast.content string

O conteúdo.
Public
 broadcast.public boolean

Se público.
Publicado em
 broadcast.published_at string

Quando publicado em.
Enviar em
 broadcast.send_at string

Quando enviado em.
Miniatura Alt
 broadcast.thumbnail_alt string

O texto alternativo para a miniatura.
URL da miniatura
 broadcast.thumbnail_url string

O endereço URL da miniatura.
Endereço de E-mail
 broadcast.email_address string

O endereço de e-mail.
Modelo de layout de e-mail
 broadcast.email_layout_template string

O modelo de layout de e-mail.

Destruir uma transmissão

ID da Operação:
BroadcastDelete

Exclua permanentemente um rascunho ou um registro de transmissão agendada. As transmissões que estão sendo enviadas no momento ou que foram enviadas não podem ser excluídas.

Parâmetros

Name Chave Necessário Tipo Description
ID de transmissão
 broadcast_id True string

O identificador exclusivo de transmissão.

Devoluções

response
string

Lista de subscritores

ID da Operação:
SubscriberList

Devolve uma lista dos seus subscritores. Apenas para cancelar inscrições, use o valor cancelado em para param de campo de classificação (atualmente o único campo de classificação extra suportado).

Parâmetros

Name Chave Necessário Tipo Description
De
 from string

O de.
Para
 to string

O para.
Atualizado de
 updated_from string

Quando atualizado de.
Atualizado para
 updated_to string

Quando atualizado para.
Ordem de classificação
 sort_order string

A ordem de classificação.
Campo de classificação
 sort_field string

O campo de classificação.
Endereço de E-mail
 email_address string

O endereço de e-mail.
Página
 page integer

A página.

Devoluções

Name Caminho Tipo Description
Total de Subscritores
 total_subscribers integer

O total de assinantes.
Página
 page integer

A página.
Total de Páginas
 total_pages integer

O total de páginas.
Subscribers
 subscribers array of object
ID
 subscribers.id integer

O identificador único.
Nome Próprio
 subscribers.first_name string

O primeiro nome.
Endereço de E-mail
 subscribers.email_address string

O endereço de e-mail.
Estado
 subscribers.state string

O Estado.
Criado em
 subscribers.created_at string

Quando criado em.
Apelido
 subscribers.fields.last_name string

O sobrenome.

Listar assinaturas de um formulário

ID da Operação:
FormSubList

Recupera uma lista de assinaturas de um formulário, incluindo dados do assinante.

Parâmetros

Name Chave Necessário Tipo Description
ID do formulário
 form_id True string

O identificador exclusivo do formulário.
Ordem de classificação
 sort_order string

A ordem de classificação.
Estado do Assinante
 subscriber_state string

O estado do assinante.
Página
 page integer

A página.

Devoluções

Name Caminho Tipo Description
Total de Subscrições
 total_subscriptions integer

O total de subscrições.
Página
 page integer

A página.
Total de Páginas
 total_pages integer

O total de páginas.
Subscrições
 subscriptions array of object
ID
 subscriptions.id integer

O identificador único.
Estado
 subscriptions.state string

O Estado.
Criado em
 subscriptions.created_at string

Quando criado em.
Fonte
 subscriptions.source string

A fonte.
Referenciador
 subscriptions.referrer string

O referenciador.
ID subscritível
 subscriptions.subscribable_id integer

O identificador único subscrito.
Tipo subscrito
 subscriptions.subscribable_type string

O tipo subscritível.
ID
 subscriptions.subscriber.id integer

O identificador único.
Nome Próprio
 subscriptions.subscriber.first_name string

O primeiro nome.
Endereço de E-mail
 subscriptions.subscriber.email_address string

O endereço de e-mail.
Estado
 subscriptions.subscriber.state string

O Estado.
Criado em
 subscriptions.subscriber.created_at string

Quando criado em.
Apelido
 subscriptions.subscriber.fields.last_name string

O sobrenome.

Listar assinaturas de uma sequência

ID da Operação:
SequenceSubList

Recupera assinaturas de uma sequência, incluindo dados do assinante.

Parâmetros

Name Chave Necessário Tipo Description
ID da sequência
 sequence_id True string

O identificador exclusivo da sequência.
Ordem de classificação
 sort_order string

A ordem de classificação.
Estado do Assinante
 subscriber_state string

O estado do assinante.
Página
 page integer

A página.

Devoluções

Name Caminho Tipo Description
Total de Subscrições
 total_subscriptions integer

O total de subscrições.
Página
 page integer

A página.
Total de Páginas
 total_pages integer

O total de páginas.
Subscrições
 subscriptions array of object
ID
 subscriptions.id integer

O identificador único.
Estado
 subscriptions.state string

O Estado.
Criado em
 subscriptions.created_at string

Quando criado em.
Fonte
 subscriptions.source string

A fonte.
Referenciador
 subscriptions.referrer string

O referenciador.
ID subscritível
 subscriptions.subscribable_id integer

O identificador único subscrito.
Tipo subscrito
 subscriptions.subscribable_type string

O tipo subscritível.
ID
 subscriptions.subscriber.id integer

O identificador único.
Nome Próprio
 subscriptions.subscriber.first_name string

O primeiro nome.
Endereço de E-mail
 subscriptions.subscriber.email_address string

O endereço de e-mail.
Estado
 subscriptions.subscriber.state string

O Estado.
Criado em
 subscriptions.subscriber.created_at string

Quando criado em.
Apelido
 subscriptions.subscriber.fields.last_name string

O sobrenome.

Listar assinaturas de uma tag

ID da Operação:
TagSubList

Recupera uma lista de assinaturas de uma tag incluindo dados do assinante.

Parâmetros

Name Chave Necessário Tipo Description
ID da etiqueta
 tag_id True string

O identificador exclusivo da tag.
Ordem de classificação
 sort_order string

A ordem de classificação.
Estado do Assinante
 subscriber_state string

O estado do assinante.
Página
 page integer

A página.

Devoluções

Name Caminho Tipo Description
Total de Subscrições
 total_subscriptions integer

O total de subscrições.
Página
 page integer

A página.
Total de Páginas
 total_pages integer

O total de páginas.
Subscrições
 subscriptions array of object
ID
 subscriptions.id integer

O identificador único.
Estado
 subscriptions.state string

O Estado.
Criado em
 subscriptions.created_at string

Quando criado em.
Fonte
 subscriptions.source string

A fonte.
Referenciador
 subscriptions.referrer string

O referenciador.
ID subscritível
 subscriptions.subscribable_id integer

O identificador único subscrito.
Tipo subscrito
 subscriptions.subscribable_type string

O tipo subscritível.
ID
 subscriptions.subscriber.id integer

O identificador único.
Nome Próprio
 subscriptions.subscriber.first_name string

O primeiro nome.
Endereço de E-mail
 subscriptions.subscriber.email_address string

O endereço de e-mail.
Estado
 subscriptions.subscriber.state string

O Estado.
Criado em
 subscriptions.subscriber.created_at string

Quando criado em.
Apelido
 subscriptions.subscriber.fields.last_name string

O sobrenome.

Listar compras

ID da Operação:
PurchaseList

Recupere uma lista de todas as compras de uma conta.

Parâmetros

Name Chave Necessário Tipo Description
Página
 page integer

A página.

Devoluções

Name Caminho Tipo Description
Total de Compras
 total_purchases integer

O total de compras.
Página
 page integer

A página.
Total de Páginas
 total_pages integer

O total de páginas.
Compras
 purchases array of object
ID
 purchases.id integer

O identificador único.
ID da transação
 purchases.transaction_id string

O identificador exclusivo da transação.
Situação
 purchases.status string

O status.
Endereço de E-mail
 purchases.email_address string

O endereço de e-mail.
Moeda
 purchases.currency string

A moeda.
Tempo de Transação
 purchases.transaction_time string

O tempo da transação.
Subtotal
 purchases.subtotal integer

O subtotal.
Envio
 purchases.shipping integer

O envio.
Desconto
 purchases.discount integer

O desconto.
Imposto
 purchases.tax integer

O imposto.
Total
 purchases.total integer

O total.
Products
 purchases.products array of object
Preço por Unidade
 purchases.products.unit_price integer

O preço unitário.
Quantidade
 purchases.products.quantity integer

A quantidade.
SKU
 purchases.products.sku string

O SKU.
Nome
 purchases.products.name string

O nome.

Listar sequências

ID da Operação:
SequenceList

Recupera uma lista de sequências para a conta.

Devoluções

Name Caminho Tipo Description
Courses
 courses array of object
ID
 courses.id integer

O identificador único.
Nome
 courses.name string

O nome.
Criado em
 courses.created_at string

Quando criado em.

Listar tags de assinante

ID da Operação:
SubscriberTags

Recupera uma lista de todas as tags de um assinante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Assinante
 subscriber_id True string

O identificador exclusivo do assinante.

Devoluções

Name Caminho Tipo Description
Etiquetas
 tags array of object
ID
 tags.id integer

O identificador único.
Nome
 tags.name string

O nome.
Criado em
 tags.created_at string

Quando criado em.

Listar transmissões

ID da Operação:
BroadcastList

Recupera uma lista de todas as transmissões da sua conta.

Devoluções

Name Caminho Tipo Description
Transmissões
 broadcasts array of object
ID
 broadcasts.id integer

O identificador único.
Criado em
 broadcasts.created_at string

Quando criado em.
Assunto
 broadcasts.subject string

O assunto.

Marcar um assinante

ID da Operação:
TagSub

As tags são tratadas como assinaturas. Inscreva um endereço de e-mail em uma tag para que essa tag seja aplicada ao assinante com esse endereço de e-mail.

Parâmetros

Name Chave Necessário Tipo Description
ID da etiqueta
 tag_id True string

O identificador exclusivo da tag.
Email
 email string

O endereço de e-mail.
Nome Próprio
 first_name string

O primeiro nome.
Etiquetas
 tags array of integer

Devoluções

Name Caminho Tipo Description
ID
 subscription.id integer

O identificador único.
Estado
 subscription.state string

O Estado.
Criado em
 subscription.created_at string

Quando criado em.
Fonte
 subscription.source string

A fonte.
Referenciador
 subscription.referrer string

O referenciador.
ID subscritível
 subscription.subscribable_id integer

O identificador único subscrito.
Tipo subscrito
 subscription.subscribable_type string

O tipo subscritível.
ID
 subscription.subscriber.id integer

O identificador único.

Obter conta

ID da Operação:
Account

Recupera a conta corrente.

Devoluções

Name Caminho Tipo Description
Nome
 name string

O nome.
Tipo de Plano
 plan_type string

O tipo de plano.
Endereço de e-mail principal
 primary_email_address string

O endereço de e-mail principal.

Obter estatísticas de transmissão

ID da Operação:
BroadcastGetStat

Recupera as estatísticas (contagem de destinatários, taxa de abertura, taxa de cliques, contagem de cancelamento de inscrição, total de cliques, status e progresso de envio) de uma transmissão específica.

Parâmetros

Name Chave Necessário Tipo Description
ID de transmissão
 broadcast_id True string

O identificador exclusivo de transmissão.

Devoluções

Name Caminho Tipo Description
Transmissão
 broadcast array of object
ID
 broadcast.id integer

O identificador único.
Destinatários
 broadcast.stats.recipients integer

Os destinatários.
Taxa de Abertura
 broadcast.stats.open_rate float

A taxa de abertura.
Taxa de cliques
 broadcast.stats.click_rate float

A taxa de cliques.
Anula a subscrição
 broadcast.stats.unsubscribes integer

O cancelamento de inscrições.
Total de cliques
 broadcast.stats.total_clicks integer

O total de cliques.
Mostrar total de cliques
 broadcast.stats.show_total_clicks boolean

Se deseja mostrar o total de cliques.
Situação
 broadcast.stats.status string

O status.
Progress
 broadcast.stats.progress integer

O progresso.

Obter formulários

ID da Operação:
FormList

Recupere uma lista de todos os formulários da sua conta.

Devoluções

Name Caminho Tipo Description
Forms
 forms array of object
ID
 forms.id integer

O identificador único.
Nome
 forms.name string

O nome.
Criado em
 forms.created_at string

Quando criado em.
Tipo
 forms.type string

O tipo.
Formato
 forms.format string

O formato.
URL
 forms.url string

O endereço URL.
Incorporar JS
 forms.embed_js string

O Javascript a incorporar.
URL de incorporação
 forms.embed_url string

O endereço URL a incorporar.
Title
 forms.title string

O título.
Description
 forms.description string

A descrição.
Texto do botão Inscrever-se
 forms.sign_up_button_text string

O texto do botão de inscrição.
Mensagem de Sucesso
 forms.success_message string

A mensagem de sucesso.
Arquivado
 forms.archived boolean

Se arquivado.
UID
 forms.uid string

O identificador único.

Obter um subscritor

ID da Operação:
SubscriberGet

Recupera um único registro de assinante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Assinante
 subscriber_id True string

O identificador exclusivo do assinante.

Devoluções

Name Caminho Tipo Description
ID
 subscriber.id integer

O identificador único.
Nome Próprio
 subscriber.first_name string

O primeiro nome.
Endereço de E-mail
 subscriber.email_address string

O endereço de e-mail.
Estado
 subscriber.state string

O Estado.
Criado em
 subscriber.created_at string

Quando criado em.
Apelido
 subscriber.fields.last_name string

O sobrenome.

Obter uma compra

ID da Operação:
PurchaseGet

Recupere uma compra específica por ID.

Parâmetros

Name Chave Necessário Tipo Description
ID de compra
 purchase_id True string

O identificador de compra.

Devoluções

Name Caminho Tipo Description
ID
 id integer

O identificador único.
ID da transação
 transaction_id string

O identificador exclusivo da transação.
Situação
 status string

O status.
Endereço de E-mail
 email_address string

O endereço de e-mail.
Moeda
 currency string

A moeda.
Tempo de Transação
 transaction_time string

O tempo da transação.
Subtotal
 subtotal integer

O subtotal.
Envio
 shipping integer

O envio.
Desconto
 discount integer

O desconto.
Imposto
 tax integer

O imposto.
Total
 total integer

O total.
Products
 products array of object
Preço por Unidade
 products.unit_price integer

O preço unitário.
Quantidade
 products.quantity integer

A quantidade.
SKU
 products.sku string

O SKU.
Nome
 products.name string

O nome.

Recuperar uma transmissão

ID da Operação:
BroadcastGet

Recupera os detalhes de uma transmissão específica, incluindo transmissões de rascunho, agendadas e enviadas anteriormente.

Parâmetros

Name Chave Necessário Tipo Description
ID de transmissão
 broadcast_id True string

O identificador exclusivo de transmissão.

Devoluções

Name Caminho Tipo Description
ID
 broadcast.id integer

O identificador único.
Criado em
 broadcast.created_at string

Quando criado em.
Assunto
 broadcast.subject string

O assunto.
Description
 broadcast.description string

A descrição.
Content
 broadcast.content string

O conteúdo.
Public
 broadcast.public boolean

Se público.
Publicado em
 broadcast.published_at string

Quando publicado em.
Enviar em
 broadcast.send_at string

Quando enviado em.
Miniatura Alt
 broadcast.thumbnail_alt string

O texto alternativo para a miniatura.
URL da miniatura
 broadcast.thumbnail_url string

O endereço URL da miniatura.
Endereço de E-mail
 broadcast.email_address string

O endereço de e-mail.
Modelo de layout de e-mail
 broadcast.email_layout_template string

O modelo de layout de e-mail.

Remover tag do assinante

ID da Operação:
TagSubRemove

Remove uma tag de um assinante.

Parâmetros

Name Chave Necessário Tipo Description
ID do Assinante
 subscriber_id True string

O identificador exclusivo do assinante.
ID da etiqueta
 tag_id True string

O identificador exclusivo da tag.

Devoluções

Name Caminho Tipo Description
ID
 id integer

O identificador único.
Nome
 name string

O nome.
Criado em
 created_at string

Quando criado em.

Remover tag do assinante por e-mail

ID da Operação:
TagSubRemoveEmail

Remova uma tag de um assinante por endereço de e-mail.

Parâmetros

Name Chave Necessário Tipo Description
ID da etiqueta
 tag_id True string

O identificador exclusivo da tag.
Email
 email True string

O endereço de e-mail.

Devoluções

Name Caminho Tipo Description
ID
 id integer

O identificador único.
Nome
 name string

O nome.
Criado em
 created_at string

Quando criado em.

Tags de lista

ID da Operação:
TagList

Recupera uma lista de tags para a conta.

Devoluções

Name Caminho Tipo Description
Etiquetas
 tags array of object
ID
 tags.id integer

O identificador único.
Nome
 tags.name string

O nome.
Criado em
 tags.created_at string

Quando criado em.

Definições

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.