Compartilhar via

ConvertKit (Editor Independente)

O ConvertKit é o hub de marketing go-to para criadores que ajuda você a crescer e monetizar seu público com facilidade. Converta seus seguidores de mídias sociais, YouTube e muito mais em sua lista de emails com uma bela página de aterrissagem e modelos de aceitação.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Publicador Troy Taylor, Hitachi Solutions
Site https://convertkit.com/
Política de privacidade https://convertkit.com/privacy
Categorias Marketing

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default 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.

Essa não é uma conexão compartilhável. Se o aplicativo de energia 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

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar assinante a um formulário

Assine um endereço de email em um de seus formulários.
Adicionar assinante a uma sequência

Assine um endereço de email em uma de suas sequências.
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 assinatura do assinante

Cancele a assinatura de um assinante de todos os seus formulários e sequências.
Criar uma compra

Crie uma compra.
Criar uma marca

Cria uma nova marca.
Criar uma transmissão

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

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

Retorna uma lista de assinantes. Somente para cancelar assinaturas, use o valor cancelado para o parâmetro de campo de classificação (atualmente, o único campo de classificação extra com suporte).
Listar assinaturas em um formulário

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

Recupera uma lista de assinaturas para uma marca, incluindo dados do assinante.
Listar assinaturas para uma sequência

Recupera assinaturas para uma sequência, incluindo dados do assinante.
Listar compras

Recupere uma lista de todas as compras de uma conta.
Listar etiquetas

Recupera uma lista de marcas para a conta.
Listar marcas do assinante

Recupera uma lista de todas as marcas para um assinante.
Listar sequências

Recupera uma lista de sequências para a conta.
Listar transmissões

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

As marcas são tratadas como assinaturas. Assine um endereço de email em uma marca para que essa marca seja aplicada ao assinante com esse endereço de email.
Obter conta

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

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

Recupere uma lista de todos os formulários para sua conta.
Obter um assinante

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 rascunho, transmissões agendadas e enviadas anteriormente.
Remover marca do assinante

Remove uma marca de um assinante.
Remover marca do assinante por email

Remova uma marca de um assinante por endereço de email.

Adicionar assinante a um formulário

ID da operação:
FormSubAdd

Assine um endereço de email em um de seus formulários.

Parâmetros

Nome Chave Obrigató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 email.
Primeiro Nome
 first_name string

O nome.
Etiquetas
 tags array of integer

Retornos

Nome Caminho Tipo Description
ID
 subscription.id integer

O identificador exclusivo.
Estado
 subscription.state string

O estado.
Criado em
 subscription.created_at string

Quando criado em.
Source
 subscription.source string

A origem.
Referenciador
 subscription.referrer string

O referenciador.
ID de assinatura
 subscription.subscribable_id integer

O identificador exclusivo subscrito.
Tipo de assinatura
 subscription.subscribable_type string

O tipo subscrito.
ID
 subscription.subscriber.id integer

O identificador exclusivo.
Primeiro Nome
 subscription.subscriber.first_name string

O nome.
Endereço eletrônico
 subscription.subscriber.email_address string

O endereço de email.
Estado
 subscription.subscriber.state string

O estado.
Criado em
 subscription.subscriber.created_at string

Quando criado em.

Adicionar assinante a uma sequência

ID da operação:
SequenceSubAdd

Assine um endereço de email em uma de suas sequências.

Parâmetros

Nome Chave Obrigató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 email.
Primeiro Nome
 first_name string

O nome.
Etiquetas
 tags array of integer

Retornos

Nome Caminho Tipo Description
ID
 subscription.id integer

O identificador exclusivo.
Estado
 subscription.state string

O estado.
Criado em
 subscription.created_at string

Quando criado em.
Source
 subscription.source string

A origem.
Referenciador
 subscription.referrer string

O referenciador.
ID de assinatura
 subscription.subscribable_id integer

O identificador exclusivo subscrito.
Tipo de assinatura
 subscription.subscribable_type string

O tipo subscrito.
ID
 subscription.subscriber.id integer

O identificador exclusivo.

Atualizar assinante

ID da operação:
SubscriberUpdate

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Assinante
 subscriber_id True string

O identificador exclusivo do assinante.
Primeiro Nome
 first_name string

O nome.
Endereço eletrônico
 email_address string

O endereço de email.

Retornos

Nome Caminho Tipo Description
ID
 subscriber.id integer

O identificador exclusivo.
Primeiro Nome
 subscriber.first_name string

O nome.
Endereço eletrônico
 subscriber.email_address string

O endereço de email.
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

Nome Chave Obrigatório Tipo Description
ID de difusã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 eletrônico
 email_address string

O endereço de email.
Modelo de Layout de Email
 email_layout_template string

O modelo de layout de email.
Público
 public boolean

Seja 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 alt para a miniatura.
URL de miniatura
 thumbnail_url string

O endereço de URL da miniatura.

Retornos

Nome Caminho Tipo Description
ID
 broadcast.id integer

O identificador exclusivo.
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.
Público
 broadcast.public boolean

Seja público.
Publicado em
 broadcast.published_at string

Quando publicado em.
Enviar em
 broadcast.send_at string

Quando enviado.
Miniatura Alt
 broadcast.thumbnail_alt string

O texto alt para a miniatura.
URL de miniatura
 broadcast.thumbnail_url string

O endereço de URL para miniatura.
Endereço eletrônico
 broadcast.email_address string

O endereço de email.
Modelo de Layout de Email
 broadcast.email_layout_template string

O modelo de layout de email.

Cancelar assinatura do assinante

ID da operação:
SubscriberUnsub

Cancele a assinatura de um assinante de todos os seus formulários e sequências.

Parâmetros

Nome Chave Obrigatório Tipo Description
Email
 email True string

O endereço de email.

Retornos

Nome Caminho Tipo Description
ID
 subscriber.id integer

O identificador exclusivo.
Primeiro Nome
 subscriber.first_name string

O nome.
Endereço eletrônico
 subscriber.email_address string

O endereço de email.
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

Nome Chave Obrigatório Tipo Description
ID da transação
 transaction_id True string

O identificador exclusivo da transação.
Endereço eletrônico
 email_address True string

O endereço de email.
Primeiro Nome
 first_name string

O nome.
Moeda
 currency True string

A moeda.
Tempo de Transação
 transaction_time string

A hora da transação.
Subtotal
 subtotal integer

O subtotal.
Imposto
 tax integer

O imposto.
Transporte
 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.
TAMPA
 lid True integer

A LID.
Nome
 name True string

O nome.
SKU
 sku string

A SKU.
Preço unitário
 unit_price True integer

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

A quantidade.

Retornos

Nome Caminho Tipo Description
ID
 id integer

O identificador exclusivo.
ID da transação
 transaction_id string

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

O status.
Endereço eletrônico
 email_address string

O endereço de email.
Moeda
 currency string

A moeda.
Tempo de Transação
 transaction_time string

A hora da transação.
Subtotal
 subtotal integer

O subtotal.
Desconto
 discount integer

O desconto.
Imposto
 tax integer

O imposto.
Transporte
 shipping integer

O envio.
Total
 total integer

O total.
Products
 products array of object
Preço unitário
 products.unit_price integer

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

A quantidade.
SKU
 products.sku string

A SKU.
Nome
 products.name string

O nome.

Criar uma marca

ID da operação:
TagAdd

Cria uma nova marca.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome
 name True string

O nome.

Retornos

Nome Caminho Tipo Description
AccountID
 account_id integer

O identificador exclusivo da conta.
Criado em
 created_at string

Quando criado em.
Excluído em
 deleted_at string

Quando excluído em.
ID
 id integer

O identificador exclusivo.
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 nenhum atributo. As transmissões agendadas no mínimo devem conter uma linha de assunto e seu conteúdo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Description
 description string

A descrição.
Assunto
 subject string

O assunto.
Content
 content string

O conteúdo.
Endereço eletrônico
 email_address string

O endereço de email.
Modelo de Layout de Email
 email_layout_template string

O modelo de layout de email.
Público
 public boolean

Seja 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 alt para a miniatura.
URL de miniatura
 thumbnail_url string

O endereço de URL da miniatura.

Retornos

Nome Caminho Tipo Description
ID
 broadcast.id integer

O identificador exclusivo.
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.
Público
 broadcast.public boolean

Seja público.
Publicado em
 broadcast.published_at string

Quando publicado em.
Enviar em
 broadcast.send_at string

Quando enviado.
Miniatura Alt
 broadcast.thumbnail_alt string

O texto alt para a miniatura.
URL de miniatura
 broadcast.thumbnail_url string

O endereço de URL para miniatura.
Endereço eletrônico
 broadcast.email_address string

O endereço de email.
Modelo de Layout de Email
 broadcast.email_layout_template string

O modelo de layout de email.

Destruir uma transmissão

ID da operação:
BroadcastDelete

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de difusão
 broadcast_id True string

O identificador exclusivo de transmissão.

Retornos

response
string

Listar assinantes

ID da operação:
SubscriberList

Retorna uma lista de assinantes. Somente para cancelar assinaturas, use o valor cancelado para o parâmetro de campo de classificação (atualmente, o único campo de classificação extra com suporte).

Parâmetros

Nome Chave Obrigató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 classificar
 sort_field string

O campo de classificação.
Endereço eletrônico
 email_address string

O endereço de email.
Página
 page integer

A página.

Retornos

Nome Caminho Tipo Description
Total de Assinantes
 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 exclusivo.
Primeiro Nome
 subscribers.first_name string

O nome.
Endereço eletrônico
 subscribers.email_address string

O endereço de email.
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 em um formulário

ID da operação:
FormSubList

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

Parâmetros

Nome Chave Obrigató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.

Retornos

Nome Caminho Tipo Description
Total de assinaturas
 total_subscriptions integer

O total de assinaturas.
Página
 page integer

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

O total de páginas.
Subscriptions
 subscriptions array of object
ID
 subscriptions.id integer

O identificador exclusivo.
Estado
 subscriptions.state string

O estado.
Criado em
 subscriptions.created_at string

Quando criado em.
Source
 subscriptions.source string

A origem.
Referenciador
 subscriptions.referrer string

O referenciador.
ID de assinatura
 subscriptions.subscribable_id integer

O identificador exclusivo subscrito.
Tipo de assinatura
 subscriptions.subscribable_type string

O tipo subscrito.
ID
 subscriptions.subscriber.id integer

O identificador exclusivo.
Primeiro Nome
 subscriptions.subscriber.first_name string

O nome.
Endereço eletrônico
 subscriptions.subscriber.email_address string

O endereço de email.
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 para uma marca

ID da operação:
TagSubList

Recupera uma lista de assinaturas para uma marca, incluindo dados do assinante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
 tag_id True string

O identificador exclusivo da marca.
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.

Retornos

Nome Caminho Tipo Description
Total de assinaturas
 total_subscriptions integer

O total de assinaturas.
Página
 page integer

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

O total de páginas.
Subscriptions
 subscriptions array of object
ID
 subscriptions.id integer

O identificador exclusivo.
Estado
 subscriptions.state string

O estado.
Criado em
 subscriptions.created_at string

Quando criado em.
Source
 subscriptions.source string

A origem.
Referenciador
 subscriptions.referrer string

O referenciador.
ID de assinatura
 subscriptions.subscribable_id integer

O identificador exclusivo subscrito.
Tipo de assinatura
 subscriptions.subscribable_type string

O tipo subscrito.
ID
 subscriptions.subscriber.id integer

O identificador exclusivo.
Primeiro Nome
 subscriptions.subscriber.first_name string

O nome.
Endereço eletrônico
 subscriptions.subscriber.email_address string

O endereço de email.
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 para uma sequência

ID da operação:
SequenceSubList

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

Parâmetros

Nome Chave Obrigató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.

Retornos

Nome Caminho Tipo Description
Total de assinaturas
 total_subscriptions integer

O total de assinaturas.
Página
 page integer

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

O total de páginas.
Subscriptions
 subscriptions array of object
ID
 subscriptions.id integer

O identificador exclusivo.
Estado
 subscriptions.state string

O estado.
Criado em
 subscriptions.created_at string

Quando criado em.
Source
 subscriptions.source string

A origem.
Referenciador
 subscriptions.referrer string

O referenciador.
ID de assinatura
 subscriptions.subscribable_id integer

O identificador exclusivo subscrito.
Tipo de assinatura
 subscriptions.subscribable_type string

O tipo subscrito.
ID
 subscriptions.subscriber.id integer

O identificador exclusivo.
Primeiro Nome
 subscriptions.subscriber.first_name string

O nome.
Endereço eletrônico
 subscriptions.subscriber.email_address string

O endereço de email.
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

Nome Chave Obrigatório Tipo Description
Página
 page integer

A página.

Retornos

Nome 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 exclusivo.
ID da transação
 purchases.transaction_id string

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

O status.
Endereço eletrônico
 purchases.email_address string

O endereço de email.
Moeda
 purchases.currency string

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

A hora da transação.
Subtotal
 purchases.subtotal integer

O subtotal.
Transporte
 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 unitário
 purchases.products.unit_price integer

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

A quantidade.
SKU
 purchases.products.sku string

A SKU.
Nome
 purchases.products.name string

O nome.

Listar etiquetas

ID da operação:
TagList

Recupera uma lista de marcas para a conta.

Retornos

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

O identificador exclusivo.
Nome
 tags.name string

O nome.
Criado em
 tags.created_at string

Quando criado em.

Listar marcas do assinante

ID da operação:
SubscriberTags

Recupera uma lista de todas as marcas para um assinante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Assinante
 subscriber_id True string

O identificador exclusivo do assinante.

Retornos

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

O identificador exclusivo.
Nome
 tags.name string

O nome.
Criado em
 tags.created_at string

Quando criado em.

Listar sequências

ID da operação:
SequenceList

Recupera uma lista de sequências para a conta.

Retornos

Nome Caminho Tipo Description
Cursos
 courses array of object
ID
 courses.id integer

O identificador exclusivo.
Nome
 courses.name string

O nome.
Criado em
 courses.created_at string

Quando criado em.

Listar transmissões

ID da operação:
BroadcastList

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

Retornos

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

O identificador exclusivo.
Criado em
 broadcasts.created_at string

Quando criado em.
Assunto
 broadcasts.subject string

O assunto.

Marcar um assinante

ID da operação:
TagSub

As marcas são tratadas como assinaturas. Assine um endereço de email em uma marca para que essa marca seja aplicada ao assinante com esse endereço de email.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
 tag_id True string

O identificador exclusivo da marca.
Email
 email string

O endereço de email.
Primeiro Nome
 first_name string

O nome.
Etiquetas
 tags array of integer

Retornos

Nome Caminho Tipo Description
ID
 subscription.id integer

O identificador exclusivo.
Estado
 subscription.state string

O estado.
Criado em
 subscription.created_at string

Quando criado em.
Source
 subscription.source string

A origem.
Referenciador
 subscription.referrer string

O referenciador.
ID de assinatura
 subscription.subscribable_id integer

O identificador exclusivo subscrito.
Tipo de assinatura
 subscription.subscribable_type string

O tipo subscrito.
ID
 subscription.subscriber.id integer

O identificador exclusivo.

Obter conta

ID da operação:
Account

Recupera a conta atual.

Retornos

Nome Caminho Tipo Description
Nome
 name string

O nome.
Tipo de plano
 plan_type string

O tipo de plano.
Endereço de email primário
 primary_email_address string

O endereço de email 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 assinaturas, total de cliques, status e progresso de envio) para uma transmissão específica.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de difusão
 broadcast_id True string

O identificador exclusivo de transmissão.

Retornos

Nome Caminho Tipo Description
Difusão
 broadcast array of object
ID
 broadcast.id integer

O identificador exclusivo.
Destinatários
 broadcast.stats.recipients integer

Os destinatários.
Taxa aberta
 broadcast.stats.open_rate float

A taxa aberta.
Clique em Taxa
 broadcast.stats.click_rate float

A taxa de cliques.
Cancelamentos de Assinaturas
 broadcast.stats.unsubscribes integer

As assinaturas são canceladas.
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 para sua conta.

Retornos

Nome Caminho Tipo Description
Formulários
 forms array of object
ID
 forms.id integer

O identificador exclusivo.
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 da URL.
Inserir JS
 forms.embed_js string

O Javascript a ser inserido.
Inserir URL
 forms.embed_url string

O endereço de URL a ser inserido.
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 êxito
 forms.success_message string

A mensagem de sucesso.
Arquivados
 forms.archived boolean

Se arquivado.
UID
 forms.uid string

O identificador exclusivo.

Obter um assinante

ID da operação:
SubscriberGet

Recupera um único registro de assinante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Assinante
 subscriber_id True string

O identificador exclusivo do assinante.

Retornos

Nome Caminho Tipo Description
ID
 subscriber.id integer

O identificador exclusivo.
Primeiro Nome
 subscriber.first_name string

O nome.
Endereço eletrônico
 subscriber.email_address string

O endereço de email.
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

Nome Chave Obrigatório Tipo Description
ID de compra
 purchase_id True string

O identificador de compra.

Retornos

Nome Caminho Tipo Description
ID
 id integer

O identificador exclusivo.
ID da transação
 transaction_id string

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

O status.
Endereço eletrônico
 email_address string

O endereço de email.
Moeda
 currency string

A moeda.
Tempo de Transação
 transaction_time string

A hora da transação.
Subtotal
 subtotal integer

O subtotal.
Transporte
 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 unitário
 products.unit_price integer

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

A quantidade.
SKU
 products.sku string

A 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 rascunho, transmissões agendadas e enviadas anteriormente.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de difusão
 broadcast_id True string

O identificador exclusivo de transmissão.

Retornos

Nome Caminho Tipo Description
ID
 broadcast.id integer

O identificador exclusivo.
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.
Público
 broadcast.public boolean

Seja público.
Publicado em
 broadcast.published_at string

Quando publicado em.
Enviar em
 broadcast.send_at string

Quando enviado.
Miniatura Alt
 broadcast.thumbnail_alt string

O texto alt para a miniatura.
URL de miniatura
 broadcast.thumbnail_url string

O endereço de URL para miniatura.
Endereço eletrônico
 broadcast.email_address string

O endereço de email.
Modelo de Layout de Email
 broadcast.email_layout_template string

O modelo de layout de email.

Remover marca do assinante

ID da operação:
TagSubRemove

Remove uma marca de um assinante.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Assinante
 subscriber_id True string

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

O identificador exclusivo da marca.

Retornos

Nome Caminho Tipo Description
ID
 id integer

O identificador exclusivo.
Nome
 name string

O nome.
Criado em
 created_at string

Quando criado em.

Remover marca do assinante por email

ID da operação:
TagSubRemoveEmail

Remova uma marca de um assinante por endereço de email.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
 tag_id True string

O identificador exclusivo da marca.
Email
 email True string

O endereço de email.

Retornos

Nome Caminho Tipo Description
ID
 id integer

O identificador exclusivo.
Nome
 name string

O nome.
Criado em
 created_at string

Quando criado em.

Definições

cadeia

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