Marketo MA (Pré-visualização)
Marketo Automação de Marketing. Esta API fornece acesso a objetos do Marketo, como campanhas, programas, leads, listas (estáticas e inteligentes), bem como ativos do sistema de arquivos, como arquivos e pastas.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Standard | Todas as regiões do Power Automatic , exceto as seguintes: - 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 China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Standard | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Standard | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Relações com Desenvolvedores Marketo |
| URL | http://developers.marketo.com |
| developerfeedback@marketo.com |
| Metadados do conector | |
|---|---|
| Editora | Microsoft Inc. |
| Sítio Web | https://www.marketo.com/ |
| Política de privacidade | https://documents.marketo.com/legal/privacy/ |
| Termos de serviço | https://go.microsoft.com/fwlink/?linkid=2237005 |
| Categorias | Marketing; Vendas e CRM |
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 |
|---|---|---|---|
| MunchkinID | cadeia (de caracteres) | Seu Marketo MunchkinID (consulte a página de administração) | Verdade |
| ID do Cliente | cadeia (de caracteres) | ID do Cliente | Verdade |
| Segredo do Cliente | securestring | Segredo do Cliente | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar à Lista |
Adiciona um determinado conjunto de registros de pessoa a uma lista estática de destino. Há um limite de 300 lead ids por solicitação. Permissões necessárias: Read-Write Lead |
| Agendar Campanha |
Agendar remotamente uma campanha em lote para ser executada em um determinado momento. Meus tokens locais para o programa pai da campanha podem ser substituídos para a execução para personalizar o conteúdo. Ao usar o parâmetro "cloneToProgramName" descrito abaixo, esse ponto de extremidade é limitado a 20 chamadas por dia. Permissões necessárias: Executar campanha |
| Aprovar Programa |
Aprova o programa-alvo. Válido apenas para programas de e-mail não aprovados. Permissões necessárias: Read-Write ativos |
| Atualizar campo de lead |
Atualize os metadados de um campo de lead na instância de destino. Consulte as regras de atualização aqui. Permissões necessárias: Read-Write campo padrão do esquema Read-Write campo personalizado |
| Atualizar conteúdo do arquivo |
Substitui o conteúdo atual do arquivo pela carga útil incluída. Permissões necessárias: Read-Write ativos |
| Atualizar metadados da pasta |
Atualiza os metadados de uma determinada pasta. Permissões necessárias: Read-Write ativos |
| Atualizar metadados de lista estática |
Atualiza os metadados de um ativo de lista estática. Permissões necessárias: Read-Write ativos |
| Atualizar metadados do programa |
Atualiza os metadados do programa de destino. Permissões necessárias: Read-Write ativos |
| Atualizar tag do programa |
Atualizar tag do programa. Permissões necessárias: Read-Write ativos |
| Cancelar trabalho de lead de exportação |
Cancelar trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Cancelar Trabalho de Membro do Programa de Exportação |
Cancelar trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Criar ficheiro |
Cria um novo arquivo a partir da carga útil incluída. Permissões necessárias: Read-Write ativos |
| Criar lista estática |
Cria uma nova Lista Estática. Permissões necessárias: Read-Write ativos |
| Criar pasta |
Cria uma nova pasta. Permissões necessárias: Read-Write ativos |
| Criar programa |
Cria um novo programa. Permissões necessárias: Read-Write ativos |
| Criar trabalho de lead de exportação |
Crie um trabalho de exportação para critérios de pesquisa definidos através do parâmetro "filter". A solicitação retorna o "exportId" que é passado como parâmetro em chamadas subsequentes para pontos de extremidade de leads de exportação em massa. Use o ponto de extremidade Enqueue Export Lead Job para enfileirar o trabalho de exportação para processamento. Use o ponto de extremidade Get Export Lead Job Status para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Criar trabalho de membro do programa de exportação |
Crie um trabalho de exportação para critérios de pesquisa definidos através do parâmetro "filter". Request retorna o "exportId" que é passado como um parâmetro em chamadas subsequentes para pontos de extremidade de membros do programa de exportação em massa. |
| Descrever Lead2 |
Retorna a lista de campos pesquisáveis em objetos de lead na instância de destino. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Descrever Membro do Programa |
Retorna metadados sobre objetos membros do programa na instância de destino, incluindo uma lista de todos os campos disponíveis para interação por meio das APIs. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Descrever Membro do Programa |
Retorna metadados sobre objetos membros do programa na instância de destino, incluindo uma lista de todos os campos disponíveis para interação por meio das APIs. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Descrever o lead |
Retorna metadados sobre objetos principais na instância de destino, incluindo uma lista de todos os campos disponíveis para interação por meio das APIs. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Empurre o lead para o Marketo |
Upserts um lead e gera um Push Lead para a atividade Marketo. Permissões necessárias: Read-Write Lead |
| Enqueue Export Lead Job |
Enfileirar trabalho de exportação. Isso colocará o trabalho de exportação na fila e iniciará o trabalho quando os recursos de computação estiverem disponíveis. O trabalho de exportação deve estar no estado "Criado". Use o ponto de extremidade Get Export Lead Job Status para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Excluir leads |
Exclua uma lista de leads da instância de destino. Permissões necessárias: Read-Write Lead |
| Excluir lista estática |
Exclui a Lista Estática designada. Permissões necessárias: Read-Write Asset |
| Excluir lista inteligente |
Exclui a Lista inteligente designada. Permissões necessárias: Read-Write Asset |
| Excluir membros do programa |
Exclua uma lista de membros da instância de destino. Permissões necessárias: Read-Write Lead |
| Excluir pasta |
Exclui a pasta designada. A exclusão falhará se a pasta tiver conteúdo. Permissões necessárias: Read-Write ativos |
| Excluir programa |
Exclui o programa de destino. O programa não pode conter quaisquer ativos que estejam em uso fora do programa. Permissões necessárias: Read-Write ativos |
| Excluir tag de programa |
Exclua a tag de programa não necessária. Permissões necessárias: Read-Write ativos |
| Identidade |
Recupere um token de acesso do Marketo. As chamadas para este ponto de extremidade não são contadas para o limite de chamadas da API. |
| Identidade |
Recupere um token de acesso do Marketo. As chamadas para este ponto de extremidade não são contadas para o limite de chamadas da API. |
| Importar leads |
Importa um arquivo contendo registros de dados para a instância de destino. Permissões necessárias: Read-Write Lead |
| Importar membros do programa |
Importa um arquivo contendo registros de dados para a instância de destino. Permissões necessárias: Read-Write Lead |
| Lista inteligente de clones |
Clones a Lista Inteligente designada. Permissões necessárias: Read-Write Asset |
| Membro da Lista |
Verifica se os leads são membros de uma determinada lista estática. Permissões necessárias: Read-Write Lead |
| Obter arquivo de lead de exportação |
Retorna o conteúdo do arquivo de um trabalho de exportação. O trabalho de exportação deve estar no estado "Concluído". Use o ponto de extremidade Get Export Lead Job Status para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Obter arquivo de membro do programa de exportação |
Retorna o conteúdo do arquivo de um trabalho de exportação. O trabalho de exportação deve estar no estado "Concluído". Use o ponto de extremidade Get Export Program Member Job Status para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Obter arquivo por id |
Retorna o registro de arquivo para a id fornecida. Permissões necessárias: Read-Only Ativos, Read-Write Ativos |
| Obter arquivo por nome |
Retorna registros de arquivos para o nome fornecido. Permissões necessárias: Read-Only ativos, Read-Write ativos |
| Obter avisos de importação de leads |
Retorna a lista de avisos para o trabalho de lote de importação. Permissões necessárias: Read-Write Lead |
| Obter avisos de membros do programa de importação |
Retorna a lista de avisos para o trabalho de lote de importação. Permissões necessárias: Read-Write Lead |
| Obter campanha por ID |
Devolve o registo de uma campanha pelo seu ID. Permissões necessárias: campanhas Read-Only, campanhas Read-Write |
| Obter campanhas |
Retorna uma lista de registros de campanha. Permissões necessárias: Read-Only campanhas, Read-Write campanhas |
| Obter campo de lead por nome |
Recupera metadados para um único campo de lead. Permissões necessárias: Read-Write campo padrão do esquema Read-Write campo personalizado |
| Obter campo de membro do programa por nome |
Recupera metadados para um único campo de membro do programa. Permissões necessárias: Read-Write campo padrão do esquema Read-Write campo personalizado |
| Obter conteúdo da pasta |
Retorna registros para o conteúdo de uma determinada pasta. Permissões necessárias: Read-Only ativos, Read-Write ativos |
| Obter falhas de leads de importação |
Retorna a lista de falhas para o trabalho de lote de importação. Permissões necessárias: Read-Write Lead |
| Obter falhas de membros do programa de importação |
Retorna a lista de falhas para o trabalho de lote de importação. Permissões necessárias: Read-Write Lead |
| Obter ficheiros |
Retorna os arquivos da pasta fornecida. Permissões necessárias: Read-Only ativos, Read-Write ativos |
| Obter Lead por Id |
Recupera um único registro de lead por meio de sua ID Marketo. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Obter leads por ID da lista |
Recupera registros de pessoas que são membros da lista estática fornecida. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Obter leads por ID da lista |
Recupera registros de pessoas que são membros da lista estática fornecida. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Obter leads por ID do programa |
Recupera uma lista de leads que são membros do programa designado. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Obter leads por tipo de filtro |
Retorna uma lista de até 300 leads com base em uma lista de valores em um campo específico. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Obter lista estática por id |
Recupera um registro de Lista Estática por sua id. Permissões necessárias: Read-Asset ou Read-Write Ativo |
| Obter lista estática por nome |
Recupera um registro de Lista Estática por seu nome. Permissões necessárias: Read-Asset ou Read-Write ativo |
| Obter lista inteligente por id |
Recupera um registro de Lista Inteligente por sua id. Permissões necessárias: Read-Asset ou Read-Write Ativo |
| Obter lista inteligente por ID do programa |
Recupera um registro de Lista Inteligente por sua ID do Programa de E-mail. Permissões necessárias: Read-Asset ou Read-Write Ativo |
| Obter lista inteligente por nome |
Recupera um registro de Lista inteligente por seu nome. Permissões necessárias: Read-Asset ou Read-Write ativo |
| Obter lista por id |
Retorna um registro de lista por sua id. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Obter listas |
Retorna um conjunto de registros de lista estática com base em determinados parâmetros de filtro. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Obter listas estáticas |
Recupera uma lista de registros de Lista Estática. Permissões necessárias: Read-Asset ou Read-Write ativo |
| Obter listas inteligentes |
Recupera uma lista de registros de Lista Inteligente criados pelo usuário. Permissões necessárias: Read-Asset ou Read-Write ativo |
| Obter membros do programa |
Retorna uma lista de até 300 membros do programa em uma lista de valores em um campo específico. Se você especificar um filterType que seja um campo personalizado, o dataType do campo personalizado deverá ser "string" ou "integer". Se você especificar um filterType diferente de "leadId", um máximo de 100.000 registros de membros do programa podem ser processados pela solicitação. Permissões necessárias: Read-Only Lead Read-Write Lead |
| Obter pasta por id |
Retorna o registro da pasta com a id fornecida. Permissões necessárias: Read-Only Ativos, Read-Write Ativos |
| Obter pasta por nome |
Retorna um registro de pasta para o nome fornecido. Permissões necessárias: Read-Only ativos, Read-Write ativos |
| Obter pastas |
Recupera pastas filho de dentro de uma determinada pasta raiz. Permissões necessárias: Read-Only ativos, Read-Write ativos |
| Obter programa por id |
Recupera o registro do programa para a id fornecida. Permissões necessárias: Read-Only Ativos, Read-Write Ativos |
| Obter programa por nome |
Recupera o registro do programa para o nome fornecido. Permissões necessárias: Read-Only ativos, Read-Write ativos |
| Obter Programas |
Recupera a lista de programas acessíveis da instância de destino. Permissões necessárias: Read-Only ativos, Read-Write ativos |
| Obter programas por tag |
Recupera uma lista de programas que correspondem ao tipo de tag e aos valores de tag fornecidos. Permissões necessárias: Read-Only ativos, Read-Write ativos |
| Obter status de lead de importação |
Retorna o status de um trabalho em lote de importação. Permissões necessárias: Read-Write Lead |
| Obter status de membro do programa de importação |
Retorna o status de um trabalho em lote de importação. Permissões necessárias: Read-Write Lead |
| Obter status de trabalho de lead de exportação |
Retorna o status de um trabalho de exportação. O status do trabalho fica disponível por 30 dias após o status Concluído ou Reprovado ter sido atingido. Permissões necessárias: Read-Only Lead |
| Obter status de trabalho de membro do programa de exportação |
Retorna o status de um trabalho de exportação. O status do trabalho fica disponível por 30 dias após o status Concluído ou Reprovado ter sido atingido. Permissões necessárias: Read-Only Lead |
| Obter trabalhos de lead de exportação |
Retorna uma lista de trabalhos de exportação que foram criados nos últimos 7 dias. Permissões necessárias: Read-Only Lead |
| Obter vagas de membro do programa de exportação |
Retorna uma lista de trabalhos de exportação que foram criados nos últimos 7 dias. Permissões necessárias: Read-Only Lead |
| Programa Clone |
Clones o programa alvo. Permissões necessárias: Read-Write ativos |
| Programa de reprovação |
Não aprova o programa-alvo. Válido apenas para programas de e-mail aprovados. Permissões necessárias: Read-Write ativos |
| Remover da lista |
Remove um determinado conjunto de registros de pessoas de uma lista estática de destino. Permissões necessárias: Read-Write Lead |
| Sincronizar dados de membros do programa |
Altera os dados do membro do programa de uma lista de leads em um programa de destino. Apenas os membros existentes do programa podem ter os seus dados alterados com esta API. Permissões necessárias: Read-Write Lead |
| Sincronizar leads |
Sincroniza uma lista de leads com a instância de destino. Permissões necessárias: Read-Write Lead |
| Sincronizar status de membro do programa |
Altera o status de membro do programa de uma lista de leads em um programa de destino. Se o membro não fizer parte do programa, o membro será adicionado ao programa. Permissões necessárias: Read-Write Lead |
| Solicitar Campanha |
Passa um conjunto de leads para uma campanha de gatilho para percorrer o fluxo da campanha. A campanha designada deve ter um gatilho Campaign is Requested: Web Service API e deve estar ativa. Meus tokens locais para o programa pai da campanha podem ser substituídos para a execução para personalizar o conteúdo. É permitido um máximo de 100 leads por chamada. Permissões necessárias: Executar campanha |
| Trabalho de Membro do Programa de Exportação de Enfila |
Enfileirar trabalho de exportação. Isso colocará o trabalho de exportação na fila e iniciará o trabalho quando os recursos de computação estiverem disponíveis. O trabalho de exportação deve estar no estado "Criado". |
Adicionar à Lista
Adiciona um determinado conjunto de registros de pessoa a uma lista estática de destino. Há um limite de 300 lead ids por solicitação. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista de destino
|
listId | True | integer |
Id da lista de destino |
|
id
|
id | True | integer |
ID inteiro exclusivo de um registro de lead |
|
Lista separada por vírgulas de IDs de leads para adicionar à lista
|
id | array |
Lista separada por vírgulas de IDs de leads para adicionar à lista |
Devoluções
Agendar Campanha
Agendar remotamente uma campanha em lote para ser executada em um determinado momento. Meus tokens locais para o programa pai da campanha podem ser substituídos para a execução para personalizar o conteúdo. Ao usar o parâmetro "cloneToProgramName" descrito abaixo, esse ponto de extremidade é limitado a 20 chamadas por dia. Permissões necessárias: Executar campanha
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da campanha em lote a ser agendada.
|
campaignId | True | integer |
ID da campanha em lote a ser agendada. |
|
cloneToProgramName
|
cloneToProgramName | string |
Nome do programa resultante. Quando definido, esse atributo fará com que a campanha, o programa pai e todos os seus ativos sejam criados com o novo nome resultante. O programa pai será clonado e a campanha recém-criada será agendada. O programa resultante é criado abaixo do pai. Programas com trechos, notificações push, mensagens no aplicativo, listas estáticas, relatórios e ativos sociais não podem ser clonados dessa maneira |
|
|
runAt
|
runAt | date-time |
Data/hora em que a campanha é executada. Se não for definida, a campanha será executada cinco minutos após a chamada ser feita |
|
|
nome
|
name | True | string |
Nome do token. Deve ser formatado como "{{my.name}}" |
|
valor
|
value | True | string |
Valor do token |
Devoluções
- Body
- ResponseOfCampaign
Aprovar Programa
Aprova o programa-alvo. Válido apenas para programas de e-mail não aprovados. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
Devoluções
- Body
- ResponseOfIdResponse
Atualizar campo de lead
Atualize os metadados de um campo de lead na instância de destino. Consulte as regras de atualização aqui. Permissões necessárias: Read-Write campo padrão do esquema Read-Write campo personalizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O nome da API do campo de lead
|
fieldApiName | True | string |
O nome da API do campo de lead |
|
nome de exibição
|
displayName | string |
Nome de exibição da interface do usuário do campo |
|
|
descrição
|
description | string |
Descrição do campo |
|
|
isHidden
|
isHidden | boolean |
Se definido como true, o campo fica oculto. O padrão é false |
|
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Se definido como true, o campo é codificado como HTML no e-mail. O padrão é true |
|
|
isSensitive
|
isSensitive | boolean |
Se definido como true, o campo é marcado como sensível. O padrão é false |
Devoluções
Atualizar conteúdo do arquivo
Substitui o conteúdo atual do arquivo pela carga útil incluída. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id do arquivo
|
id | True | integer |
Id para arquivo no banco de dados |
|
ficheiro
|
file | True | string |
Arquivo com várias partes. Conteúdo do ficheiro. |
|
id
|
id | True | integer |
ID do ficheiro |
Devoluções
Atualizar metadados da pasta
Atualiza os metadados de uma determinada pasta. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id da pasta a ser atualizada
|
id | True | integer |
Id da pasta a ser atualizada |
|
descrição
|
description | string |
Descrição do ativo |
|
|
isArquivo
|
isArchive | boolean |
Se a pasta está arquivada ou não. Alternar esse valor alterará o status de arquivamento da pasta |
|
|
nome
|
name | string |
Nome da pasta |
|
|
tipo
|
type | True | string |
Tipo de pasta. 'Pasta' ou 'Programa' |
Devoluções
Atualizar metadados de lista estática
Atualiza os metadados de um ativo de lista estática. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista estática a ser atualizada
|
id | True | integer |
Id da lista estática a ser atualizada |
|
descrição
|
description | string |
Descrição da lista estática |
|
|
nome
|
name | string |
Nome da lista estática |
Devoluções
Atualizar metadados do programa
Atualiza os metadados do programa de destino. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
|
custo
|
cost | True | integer |
Montante do custo |
|
Observação
|
note | string |
Notas sobre o custo |
|
|
startDate
|
startDate | True | date-time |
Data de início do custo do período |
|
custosAtualização destrutiva
|
costsDestructiveUpdate | boolean |
Defina true para destruir os custos existentes e substituí-los pelos custos especificados |
|
|
descrição
|
description | string |
Descrição atualizada para o programa |
|
|
data de término
|
endDate | string |
Data de fim do programa. Aplicável a programas do tipo evento, e-mail e webinar |
|
|
nome
|
name | string |
Nome do programa |
|
|
startDate
|
startDate | string |
Data de início do programa. Aplicável a programas do tipo evento, e-mail e webinar |
|
|
Tipo de etiqueta
|
tagType | string |
Tipo de tag de programa |
|
|
tagValue
|
tagValue | string |
Valor da tag |
Devoluções
Atualizar tag do programa
Atualizar tag do programa. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
|
Tipo de tag de programa
|
tagType | True | string |
Tipo de tag de programa |
|
Valor da tag do programa
|
tagValue | True | string |
Valor da tag do programa |
Devoluções
- Body
- ResponseOfIdResponse
Cancelar trabalho de lead de exportação
Cancelar trabalho de exportação. Permissões necessárias: Read-Only Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho em lote de exportação.
|
exportId | True | string |
Id do trabalho em lote de exportação. |
Devoluções
Cancelar Trabalho de Membro do Programa de Exportação
Cancelar trabalho de exportação. Permissões necessárias: Read-Only Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho em lote de exportação.
|
exportId | True | string |
Id do trabalho em lote de exportação. |
Devoluções
Criar ficheiro
Cria um novo arquivo a partir da carga útil incluída. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string |
Descrição do ativo |
|
|
ficheiro
|
file | True | string |
Arquivo com várias partes. Conteúdo do ficheiro. |
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
|
inserirApenas
|
insertOnly | boolean |
Se as chamadas falharem se já existir um ficheiro com o mesmo nome |
|
|
nome
|
name | True | string |
Nome do ficheiro |
Devoluções
Criar lista estática
Cria uma nova Lista Estática. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string |
Descrição da lista estática |
|
|
nome
|
name | True | string |
Nome da lista estática |
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
Devoluções
Criar pasta
Cria uma nova pasta. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string |
Descrição do ativo |
|
|
nome
|
name | True | string |
Nome da pasta |
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
Devoluções
Criar programa
Cria um novo programa. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
canal
|
channel | True | string |
Canal do programa |
|
custo
|
cost | True | integer |
Montante do custo |
|
Observação
|
note | string |
Notas sobre o custo |
|
|
startDate
|
startDate | True | date-time |
Data de início do custo do período |
|
descrição
|
description | string | ||
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
|
nome
|
name | True | string |
Nome do programa |
|
Tipo de etiqueta
|
tagType | string |
Tipo de tag de programa |
|
|
tagValue
|
tagValue | string |
Valor da tag |
|
|
tipo
|
type | True | string |
Tipo de programa |
Devoluções
Criar trabalho de lead de exportação
Crie um trabalho de exportação para critérios de pesquisa definidos através do parâmetro "filter". A solicitação retorna o "exportId" que é passado como parâmetro em chamadas subsequentes para pontos de extremidade de leads de exportação em massa. Use o ponto de extremidade Enqueue Export Lead Job para enfileirar o trabalho de exportação para processamento. Use o ponto de extremidade Get Export Lead Job Status para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | True | string |
Nome da API REST para campo de cabeçalho |
|
valor
|
value | True | string |
Valor para o campo de cabeçalho |
|
campos
|
fields | True | array of string |
Lista separada por vírgulas de campos a incluir no ficheiro |
|
endAt
|
endAt | string |
Filtro de fim de intervalo de datas (formato ISO 8601) |
|
|
startAt
|
startAt | string |
Início do filtro de intervalo de datas (formato ISO-8601) |
|
|
smartListId
|
smartListId | True | integer |
Id da lista inteligente para recuperar leads de |
|
smartListName
|
smartListName | True | string |
Nome da lista inteligente para recuperar leads |
|
staticListId
|
staticListId | True | integer |
Id da lista estática para recuperar leads de |
|
staticListName
|
staticListName | True | string |
Nome da lista estática para recuperar leads de |
|
format
|
format | string |
Formato de ficheiro a criar("CSV", "TSV", "SSV"). O padrão é "CSV" |
Devoluções
Criar trabalho de membro do programa de exportação
Crie um trabalho de exportação para critérios de pesquisa definidos através do parâmetro "filter". Request retorna o "exportId" que é passado como um parâmetro em chamadas subsequentes para pontos de extremidade de membros do programa de exportação em massa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | True | string |
Nome da API REST para campo de cabeçalho |
|
valor
|
value | True | string |
Valor para o campo de cabeçalho |
|
campos
|
fields | True | array of string |
Lista separada por vírgulas de campos a incluir no ficheiro |
|
Id do programa
|
programId | True | integer |
Id do programa para recuperar membros. Não pode ser usado em combinação com o filtro "programIds" |
|
programIds
|
programIds | True | array of integer |
Matriz de ids de programa para recuperar membros. Não pode ser usado em combinação com o filtro "programId" |
|
isEsgotado
|
isExhausted | boolean |
Filtrar registros de associação ao programa para pessoas que esgotaram o conteúdo |
|
|
nutrirCadência
|
nurtureCadence | string |
Filtrar registros de associação ao programa para uma determinada cadência de nutrição |
|
|
statusNomes
|
statusNames | array of string |
Matriz de nomes de status de membros do programa. Pode ser padrão e/ou definido pelo usuário. Vários nomes de status são ORed juntos. |
|
|
endAt
|
endAt | string |
Filtro de fim de intervalo de datas (formato ISO 8601) |
|
|
startAt
|
startAt | string |
Início do filtro de intervalo de datas (formato ISO-8601) |
|
|
format
|
format | string |
Formato de ficheiro a criar("CSV", "TSV", "SSV"). O padrão é "CSV" |
Devoluções
Descrever Lead2
Retorna a lista de campos pesquisáveis em objetos de lead na instância de destino. Permissões necessárias: Read-Only Lead Read-Write Lead
Devoluções
Descrever Membro do Programa
Retorna metadados sobre objetos membros do programa na instância de destino, incluindo uma lista de todos os campos disponíveis para interação por meio das APIs. Permissões necessárias: Read-Only Lead Read-Write Lead
Nota: Este ponto de extremidade foi substituído. Em vez disso, use o ponto de extremidade Descrever Membro do Programa .
Devoluções
Descrever Membro do Programa
Retorna metadados sobre objetos membros do programa na instância de destino, incluindo uma lista de todos os campos disponíveis para interação por meio das APIs. Permissões necessárias: Read-Only Lead Read-Write Lead
Devoluções
Descrever o lead
Retorna metadados sobre objetos principais na instância de destino, incluindo uma lista de todos os campos disponíveis para interação por meio das APIs. Permissões necessárias: Read-Only Lead Read-Write Lead
Nota: Este ponto de extremidade foi substituído. Em vez disso, use Descrever o ponto de extremidade Lead2 .
Devoluções
Empurre o lead para o Marketo
Upserts um lead e gera um Push Lead para a atividade Marketo. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | integer |
ID inteiro exclusivo de um registro de lead |
|
|
código
|
code | True | string |
Código inteiro do motivo |
|
mensagem
|
message | True | string |
Mensagem descrevendo o motivo do status da operação |
|
estado
|
status | string |
Estado da operação realizada no registo |
|
|
lookupField
|
lookupField | string | ||
|
nome_da_partição
|
partitionName | string | ||
|
nomedoprograma
|
programName | string | ||
|
status do programa
|
programStatus | string | ||
|
razão
|
reason | string | ||
|
origem
|
source | string |
Devoluções
Enqueue Export Lead Job
Enfileirar trabalho de exportação. Isso colocará o trabalho de exportação na fila e iniciará o trabalho quando os recursos de computação estiverem disponíveis. O trabalho de exportação deve estar no estado "Criado". Use o ponto de extremidade Get Export Lead Job Status para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho em lote de exportação.
|
exportId | True | string |
Id do trabalho em lote de exportação. |
Devoluções
Excluir leads
Exclua uma lista de leads da instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
ID inteiro exclusivo de um registro de lead |
|
O parâmetro pode ser especificado se o corpo da solicitação estiver vazio.
|
id | array |
O parâmetro pode ser especificado se o corpo da solicitação estiver vazio. Vários lead ids podem ser especificados. por exemplo, id=1,2,3,2342 |
Devoluções
- Body
- ResponseOfLead
Excluir lista estática
Exclui a Lista Estática designada. Permissões necessárias: Read-Write Asset
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista estática a excluir
|
id | True | integer |
Id da lista estática a excluir |
Devoluções
- Body
- ResponseOfIdResponse
Excluir lista inteligente
Exclui a Lista inteligente designada. Permissões necessárias: Read-Write Asset
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista inteligente a excluir
|
id | True | integer |
ID da lista inteligente a excluir |
Devoluções
- Body
- ResponseOfIdResponse
Excluir membros do programa
Exclua uma lista de membros da instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id do programa de destino.
|
programId | True | integer |
O id do programa de destino. |
|
leadId
|
leadId | True | integer |
ID inteiro exclusivo de um registro de lead |
Devoluções
Excluir pasta
Exclui a pasta designada. A exclusão falhará se a pasta tiver conteúdo. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da pasta a ser excluída
|
id | True | integer |
Id da pasta a ser excluída |
|
tipo de pasta
|
type | True | string |
tipo |
Devoluções
- Body
- ResponseOfIdResponse
Excluir programa
Exclui o programa de destino. O programa não pode conter quaisquer ativos que estejam em uso fora do programa. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
Devoluções
- Body
- ResponseOfIdResponse
Excluir tag de programa
Exclua a tag de programa não necessária. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
|
Tipo de tag de programa
|
tagType | True | string |
Tipo de tag de programa |
Devoluções
- Body
- ResponseOfIdResponse
Identidade
Recupere um token de acesso do Marketo. As chamadas para este ponto de extremidade não são contadas para o limite de chamadas da API.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O clientID para a API REST do Marketo
|
client_id | True | string |
ID do cliente no menu Admin > Integration > Launchpoint. |
|
O segredo do cliente para a API REST do Marketo
|
client_secret | True | string |
Segredo do cliente do menu Admin > Integration > Launchpoint. |
|
O tipo de subvenção. As credenciais do nosso cliente caso
|
grant_type | True | string |
Tipo de subvenção. |
Devoluções
- Body
- ResponseOfIdentity
Identidade
Recupere um token de acesso do Marketo. As chamadas para este ponto de extremidade não são contadas para o limite de chamadas da API.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O clientID para a API REST do Marketo
|
client_id | True | string |
ID do cliente no menu Admin > Integration > Launchpoint. |
|
O segredo do cliente para a API REST do Marketo
|
client_secret | True | string |
Segredo do cliente do menu Admin > Integration > Launchpoint. |
|
O tipo de subvenção. As credenciais do nosso cliente caso
|
grant_type | True | string |
Tipo de subvenção. |
Devoluções
- Body
- ResponseOfIdentity
Importar leads
Importa um arquivo contendo registros de dados para a instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Importar formato de arquivo.
|
format | True | string |
Importar formato de arquivo. |
|
Campo a utilizar para desduplicação. Campos personalizados (string, email, inteiro)
|
lookupField | string |
Campo a utilizar para desduplicação. Campos personalizados (string, email, inteiro) e os seguintes tipos de campo são suportados: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. O padrão é e-mail. |
|
|
Nome da partição principal para a qual importar.
|
partitionName | string |
Nome da partição principal para a qual importar. |
|
|
Id da lista estática para a qual importar.
|
listId | integer |
Id da lista estática para a qual importar. |
|
|
Arquivo contendo os registros de dados a serem importados.
|
file | True | file |
Arquivo contendo os registros de dados a serem importados. |
Devoluções
Importar membros do programa
Importa um arquivo contendo registros de dados para a instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa ao qual adicionar membros.
|
programId | True | string |
ID do programa ao qual adicionar membros. |
|
Status de membro do programa para membros que estão sendo adicionados.
|
programMemberStatus | True | string |
Status de membro do programa para membros que estão sendo adicionados. |
|
Importar formato de arquivo.
|
format | True | string |
Importar formato de arquivo. |
|
Arquivo contendo os registros de dados a serem importados.
|
file | True | file |
Arquivo contendo os registros de dados a serem importados. |
Devoluções
Lista inteligente de clones
Clones a Lista Inteligente designada. Permissões necessárias: Read-Write Asset
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista inteligente para clonar
|
id | True | integer |
Id da lista inteligente para clonar |
|
nome
|
name | True | string |
Nome da lista inteligente clonada |
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
|
descrição
|
description | string |
Descrição da lista inteligente clonada |
Devoluções
Membro da Lista
Verifica se os leads são membros de uma determinada lista estática. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista estática a ser verificada
|
listId | True | integer |
ID da lista estática a ser verificada |
|
id
|
id | True | integer |
ID inteiro exclusivo de um registro de lead |
|
Lista separada por vírgulas de ids de chumbo para verificar
|
id | array |
Lista separada por vírgulas de ids de chumbo para verificar |
Devoluções
Obter arquivo de lead de exportação
Retorna o conteúdo do arquivo de um trabalho de exportação. O trabalho de exportação deve estar no estado "Concluído". Use o ponto de extremidade Get Export Lead Job Status para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead
O formato de arquivo é especificado chamando o ponto de extremidade Create Export Lead Job. Segue-se um exemplo do formato de ficheiro predefinido ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho em lote de exportação.
|
exportId | True | string |
Id do trabalho em lote de exportação. |
|
Para suportar a recuperação parcial de dados extraídos
|
Range | string |
Para suportar a recuperação parcial de dados extraídos, o cabeçalho HTTP "Range" do tipo "bytes" pode ser especificado. Consulte RFC 2616 "Range Retrieval Requests" para obter mais informações. Se o cabeçalho não estiver definido, todo o conteúdo será retornado. |
Devoluções
- response
- object
Obter arquivo de membro do programa de exportação
Retorna o conteúdo do arquivo de um trabalho de exportação. O trabalho de exportação deve estar no estado "Concluído". Use o ponto de extremidade Get Export Program Member Job Status para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead
O formato de arquivo é especificado chamando o ponto de extremidade Criar Trabalho de Membro do Programa de Exportação. Segue-se um exemplo do formato de ficheiro predefinido ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho em lote de exportação.
|
exportId | True | string |
Id do trabalho em lote de exportação. |
|
Para suportar a recuperação parcial de dados extraídos.
|
Range | string |
Para suportar a recuperação parcial de dados extraídos, o cabeçalho HTTP "Range" do tipo "bytes" pode ser especificado. Consulte RFC 2616 "Range Retrieval Requests" para obter mais informações. Se o cabeçalho não estiver definido, todo o conteúdo será retornado. |
Devoluções
- response
- object
Obter arquivo por id
Retorna o registro de arquivo para a id fornecida. Permissões necessárias: Read-Only Ativos, Read-Write Ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id do arquivo
|
id | True | integer |
Id para arquivo no banco de dados |
Devoluções
Obter arquivo por nome
Retorna registros de arquivos para o nome fornecido. Permissões necessárias: Read-Only ativos, Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O nome do arquivo
|
name | True | string |
Nome do ficheiro |
Devoluções
Obter avisos de importação de leads
Retorna a lista de avisos para o trabalho de lote de importação. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho de lote de importação.
|
batchId | True | integer |
Id do trabalho de lote de importação. |
Devoluções
- response
- object
Obter avisos de membros do programa de importação
Retorna a lista de avisos para o trabalho de lote de importação. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho de lote de importação.
|
batchId | True | integer |
Id do trabalho de lote de importação. |
Devoluções
- response
- object
Obter campanha por ID
Devolve o registo de uma campanha pelo seu ID. Permissões necessárias: campanhas Read-Only, campanhas Read-Write
Nota: Este ponto de extremidade foi substituído. Em vez disso, use o ponto de extremidade Get Smart Campaign by Id .
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
campaignId
|
campaignId | True | integer |
campaignId |
Devoluções
- Body
- ResponseOfCampaign
Obter campanhas
Retorna uma lista de registros de campanha. Permissões necessárias: Read-Only campanhas, Read-Write campanhas
Nota: Este ponto de extremidade foi substituído. Em vez disso, use o ponto de extremidade Get Smart Campaigns .
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lista separada por vírgulas de ids de campanha para retornar registros para
|
id | array |
Lista separada por vírgulas de ids de campanha para retornar registros para |
|
|
Lista de nomes separados por vírgulas para filtrar
|
name | array |
Lista de nomes separados por vírgulas para filtrar |
|
|
Lista separada por vírgulas de nomes de programas para filtrar.
|
programName | array |
Lista separada por vírgulas de nomes de programas para filtrar. Se definido, filtrará para apenas as campanhas que são filhas dos programas designados. |
|
|
Lista separada por vírgulas de nomes de espaços de trabalho para filtrar.
|
workspaceName | array |
Lista separada por vírgulas de nomes de espaços de trabalho para filtrar. Se definido, só retornará campanhas nos espaços de trabalho fornecidos. |
|
|
Número máximo de registos a devolver. Máximo e padrão é 300.
|
batchSize | integer |
Número máximo de registos a devolver. Máximo e padrão é 300. |
|
|
Um token será retornado por esse ponto de extremidade. Consulte Tokens de paginação para obter mais informações.
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
|
|
se é Solicitado gatilho e origem é API de Serviço Web
|
isTriggerable | boolean |
Definido como true para retornar campanhas ativas que têm um gatilho Campanha é Solicitado e a origem é API de Serviço Web |
Devoluções
- Body
- ResponseOfCampaign
Obter campo de lead por nome
Recupera metadados para um único campo de lead. Permissões necessárias: Read-Write campo padrão do esquema Read-Write campo personalizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O nome da API do campo de lead
|
fieldApiName | True | string |
O nome da API do campo de lead |
Devoluções
- Body
- ResponseOfLeadField
Obter campo de membro do programa por nome
Recupera metadados para um único campo de membro do programa. Permissões necessárias: Read-Write campo padrão do esquema Read-Write campo personalizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O nome da API do campo de membro do programa
|
fieldApiName | True | string |
O nome da API do campo de membro do programa |
Devoluções
- Body
- ResponseOfLeadField
Obter conteúdo da pasta
Retorna registros para o conteúdo de uma determinada pasta. Permissões necessárias: Read-Only ativos, Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da pasta a ser recuperada
|
id | True | integer |
ID da pasta a ser recuperada |
|
Número máximo de canais a devolver. Max 200, padrão 20
|
maxReturn | integer |
Número máximo de canais a devolver. Max 200, padrão 20 |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
Tipo de pasta. 'Pasta' ou 'Programa'. O padrão é 'Pasta'
|
type | True | string |
Tipo de pasta. 'Pasta' ou 'Programa'. O padrão é 'Pasta' |
Devoluções
Obter falhas de leads de importação
Retorna a lista de falhas para o trabalho de lote de importação. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho de lote de importação.
|
batchId | True | integer |
Id do trabalho de lote de importação. |
Devoluções
- response
- object
Obter falhas de membros do programa de importação
Retorna a lista de falhas para o trabalho de lote de importação. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho de lote de importação.
|
batchId | True | integer |
Id do trabalho de lote de importação. |
Devoluções
- response
- object
Obter ficheiros
Retorna os arquivos da pasta fornecida. Permissões necessárias: Read-Only ativos, Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
|
maxRetorno
|
maxReturn | integer |
Número máximo de canais a devolver. Max 200, padrão 20 |
|
|
offset
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
A pasta onde colocar o arquivo
|
folder | string |
Representação JSON da pasta pai, com membros 'id' e 'type' que podem ser 'Pasta' ou 'Programa' |
Devoluções
Obter Lead por Id
Recupera um único registro de lead por meio de sua ID Marketo. Permissões necessárias: Read-Only Lead Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O ID do líder Marketo
|
leadId | True | integer |
O ID do líder Marketo |
|
Lista separada por vírgulas de nomes de campos.
|
fields | array |
Lista separada por vírgulas de nomes de campos. Se omitido, os seguintes campos padrão serão retornados: email, updatedAt, createdAt, lastName, firstName e id. |
Devoluções
- Body
- ResponseOfLead
Obter leads por ID da lista
Recupera registros de pessoas que são membros da lista estática fornecida. Permissões necessárias: Read-Only Lead Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista estática para recuperar registros de
|
listId | True | integer |
Id da lista estática para recuperar registros de |
|
Lista separada por vírgulas dos campos principais a serem retornados para cada registro.
|
fields | array |
Lista separada por vírgulas dos campos principais a serem retornados para cada registro. Se unset retornará e-mail, updatedAt, createdAt, lastName, firstName e id |
|
|
O tamanho do lote a ser retornado. O valor máximo e padrão é 300.
|
batchSize | integer |
O tamanho do lote a ser retornado. O valor máximo e padrão é 300. |
|
|
Um token será retornado por esse ponto de extremidade. Consulte Tokens de paginação para obter mais informações.
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
Devoluções
- Body
- ResponseOfLead
Obter leads por ID da lista
Recupera registros de pessoas que são membros da lista estática fornecida. Permissões necessárias: Read-Only Lead Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista estática para recuperar registros de
|
listId | True | integer |
Id da lista estática para recuperar registros de |
|
Lista separada por vírgulas dos campos principais a serem retornados para cada registro.
|
fields | array |
Lista separada por vírgulas dos campos principais a serem retornados para cada registro. Se unset retornará e-mail, updatedAt, createdAt, lastName, firstName e id |
|
|
O tamanho do lote a ser retornado. O valor máximo e padrão é 300.
|
batchSize | integer |
O tamanho do lote a ser retornado. O valor máximo e padrão é 300. |
|
|
Um token será retornado por esse ponto de extremidade. Consulte Tokens de paginação para obter mais informações.
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
Devoluções
Obter leads por ID do programa
Recupera uma lista de leads que são membros do programa designado. Permissões necessárias: Read-Only Lead Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id do programa para recuperar de
|
programId | True | integer |
O id do programa para recuperar de |
|
Uma lista separada por vírgulas de campos a serem retornados para cada registro
|
fields | array |
Uma lista separada por vírgulas de campos a serem retornados para cada registro |
|
|
O tamanho do lote a ser retornado. O valor máximo e padrão é 300.
|
batchSize | integer |
O tamanho do lote a ser retornado. O valor máximo e padrão é 300. |
|
|
Um token será retornado por esse ponto de extremidade. Consulte Tokens de paginação para obter mais informações.
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
Devoluções
- Body
- ResponseOfLead
Obter leads por tipo de filtro
Retorna uma lista de até 300 leads com base em uma lista de valores em um campo específico. Permissões necessárias: Read-Only Lead Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O campo principal para filtrar.
|
filterType | True | string |
O campo principal para filtrar. Qualquer campo personalizado (apenas string, e-mail ou tipos inteiros) e qualquer um dos seguintes campos são suportados: cookies, email, facebookId, id, leadPartitionId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId, twitterId. |
|
Uma lista separada por vírgulas de valores para filtrar nos campos especificados.
|
filterValues | True | array |
Uma lista separada por vírgulas de valores para filtrar nos campos especificados. |
|
Uma lista separada por vírgulas de campos principais a serem retornados para cada registro
|
fields | array |
Uma lista separada por vírgulas de campos principais a serem retornados para cada registro |
|
|
O tamanho do lote a ser retornado. O valor máximo e padrão é 300.
|
batchSize | integer |
O tamanho do lote a ser retornado. O valor máximo e padrão é 300. |
|
|
Um token será retornado por esse ponto de extremidade. Consulte Tokens de paginação para obter mais informações.
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
Devoluções
- Body
- ResponseOfLead
Obter lista estática por id
Recupera um registro de Lista Estática por sua id. Permissões necessárias: Read-Asset ou Read-Write Ativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista estática a ser recuperada
|
id | True | integer |
Id da lista estática a ser recuperada |
Devoluções
Obter lista estática por nome
Recupera um registro de Lista Estática por seu nome. Permissões necessárias: Read-Asset ou Read-Write ativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da lista estática a ser recuperada
|
name | True | string |
Nome da lista estática a ser recuperada |
Devoluções
Obter lista inteligente por id
Recupera um registro de Lista Inteligente por sua id. Permissões necessárias: Read-Asset ou Read-Write Ativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista inteligente a recuperar
|
id | True | integer |
Id da lista inteligente a recuperar |
|
Defina true para preencher regras de lista inteligente. Falso padrão
|
includeRules | boolean |
Defina true para preencher regras de lista inteligente. Falso padrão |
Devoluções
Obter lista inteligente por ID do programa
Recupera um registro de Lista Inteligente por sua ID do Programa de E-mail. Permissões necessárias: Read-Asset ou Read-Write Ativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id para o programa de e-mail que contém a lista inteligente para recuperar
|
programId | True | integer |
Id para o programa de e-mail que contém a lista inteligente para recuperar |
|
Defina true para preencher regras de lista inteligente. Falso padrão
|
includeRules | boolean |
Defina true para preencher regras de lista inteligente. Falso padrão |
Devoluções
Obter lista inteligente por nome
Recupera um registro de Lista inteligente por seu nome. Permissões necessárias: Read-Asset ou Read-Write ativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da lista inteligente a ser recuperada
|
name | True | string |
Nome da lista inteligente a ser recuperada |
Devoluções
Obter lista por id
Retorna um registro de lista por sua id. Permissões necessárias: Read-Only Lead Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista estática para recuperar registros de
|
listId | True | integer |
Id da lista estática para recuperar registros de |
Devoluções
- Body
- ResponseOfStaticList
Obter listas
Retorna um conjunto de registros de lista estática com base em determinados parâmetros de filtro. Permissões necessárias: Read-Only Lead Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lista separada por vírgulas de ids de lista estática a serem retornadas
|
id | array |
Lista separada por vírgulas de ids de lista estática a serem retornadas |
|
|
Lista separada por vírgulas de nomes de listas estáticas a serem retornados
|
name | array |
Lista separada por vírgulas de nomes de listas estáticas a serem retornados |
|
|
Lista separada por vírgulas de nomes de programas.
|
programName | array |
Lista separada por vírgulas de nomes de programas. Se definido retornará todas as listas estáticas que são filhos dos programas fornecidos |
|
|
Lista separada por vírgulas de nomes de espaços de trabalho.
|
workspaceName | array |
Lista separada por vírgulas de nomes de espaços de trabalho. Se definido retornará todas as listas estáticas que são filhas dos espaços de trabalho fornecidos |
|
|
O tamanho do lote a ser retornado. O valor máximo e padrão é 300.
|
batchSize | integer |
O tamanho do lote a ser retornado. O valor máximo e padrão é 300. |
|
|
Um token será retornado por esse ponto de extremidade. Consulte Tokens de paginação para obter mais informações.
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
Devoluções
- Body
- ResponseOfStaticList
Obter listas estáticas
Recupera uma lista de registros de Lista Estática. Permissões necessárias: Read-Asset ou Read-Write ativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Representação JSON da pasta pai
|
folder | string |
Representação JSON da pasta pai, com membros 'id' e 'type' que podem ser 'Pasta' ou 'Programa' |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
Número máximo de listas estáticas a serem retornadas. Max 200, padrão 20.
|
maxReturn | integer |
Número máximo de listas estáticas a serem retornadas. Max 200, padrão 20. |
|
|
Excluir listas estáticas anteriores a esta data. Consulte Descrição do tipo de campo Data/hora.
|
earliestUpdatedAt | string |
Excluir listas estáticas anteriores a esta data. Deve ser válido ISO-8601 string. Consulte Descrição do tipo de campo Data/hora . |
|
|
Exclua listas estáticas após esta data. Consulte Descrição do tipo de campo Data/hora.
|
latestUpdatedAt | string |
Exclua listas estáticas após esta data. Deve ser válido ISO-8601 string. Consulte Descrição do tipo de campo Data/hora . |
Devoluções
Obter listas inteligentes
Recupera uma lista de registros de Lista Inteligente criados pelo usuário. Permissões necessárias: Read-Asset ou Read-Write ativo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Representação JSON da pasta pai
|
folder | string |
Representação JSON da pasta pai, com membros 'id' e 'type' que podem ser 'Pasta' ou 'Programa' |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
Número máximo de listas inteligentes a serem retornadas. Max 200, padrão 20.
|
maxReturn | integer |
Número máximo de listas inteligentes a serem retornadas. Max 200, padrão 20. |
|
|
Exclua listas inteligentes anteriores a esta data. Consulte Descrição do tipo de campo Data/hora.
|
earliestUpdatedAt | string |
Exclua listas inteligentes anteriores a esta data. Deve ser válido ISO-8601 string. Consulte Descrição do tipo de campo Data/hora . |
|
|
Exclua listas inteligentes após esta data. Consulte Descrição do tipo de campo Data/hora.
|
latestUpdatedAt | string |
Exclua listas inteligentes após esta data. Deve ser válido ISO-8601 string. Consulte Descrição do tipo de campo Data/hora . |
Devoluções
Obter membros do programa
Retorna uma lista de até 300 membros do programa em uma lista de valores em um campo específico. Se você especificar um filterType que seja um campo personalizado, o dataType do campo personalizado deverá ser "string" ou "integer". Se você especificar um filterType diferente de "leadId", um máximo de 100.000 registros de membros do programa podem ser processados pela solicitação. Permissões necessárias: Read-Only Lead Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id do programa de destino.
|
programId | True | integer |
O id do programa de destino. |
|
O campo de membro do programa a filtrar.
|
filterType | True | string |
O campo de membro do programa para filtrar. Qualquer campo personalizado (somente tipos de cadeia de caracteres ou inteiros), "updatedAt" ou qualquer campo pesquisável. Os campos pesquisáveis podem ser obtidos através do ponto de extremidade Descrever Membro do Programa . |
|
Uma lista separada por vírgulas de valores para filtrar nos campos especificados.
|
filterValues | True | array |
Uma lista separada por vírgulas de valores para filtrar nos campos especificados. |
|
Ao usar filterType=updatedAt, o filtro de início do intervalo de datas
|
startAt | string |
Ao usar filterType=updatedAt, o início do filtro de intervalo de datas (formato ISO 8601) |
|
|
Ao usar filterType=updatedAt, o filtro de fim de intervalo de datas
|
endAt | string |
Ao usar filterType=updatedAt, o filtro de fim de intervalo de datas (formato ISO 8601) |
|
|
Uma lista separada por vírgulas de campos principais a serem retornados para cada registro.
|
fields | array |
Uma lista separada por vírgulas de campos principais a serem retornados para cada registro. |
|
|
O tamanho do lote a ser retornado. O valor máximo e padrão é 300.
|
batchSize | integer |
O tamanho do lote a ser retornado. O valor máximo e padrão é 300. |
|
|
Um token será retornado se o conjunto de resultados for maior que o tamanho do lote.
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
Devoluções
Obter pasta por id
Retorna o registro da pasta com a id fornecida. Permissões necessárias: Read-Only Ativos, Read-Write Ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id da pasta a ser recuperada
|
id | True | integer |
ID da pasta a ser recuperada |
|
O tipo da pasta (Programa ou Pasta)
|
type | True | string |
Tipo de pasta. 'Pasta' ou 'Programa' |
Devoluções
Obter pasta por nome
Retorna um registro de pasta para o nome fornecido. Permissões necessárias: Read-Only ativos, Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O nome da pasta
|
name | True | string |
Nome da pasta. Não aplicável a Programas |
|
O tipo da pasta (Programa ou Pasta)
|
type | string |
Tipo de pasta. 'Pasta' ou 'Programa' |
|
|
A referência da pasta pai
|
root | string |
Referência da pasta pai |
|
|
O nome do espaço de trabalho
|
workSpace | string |
Nome do espaço de trabalho |
Devoluções
Obter pastas
Recupera pastas filho de dentro de uma determinada pasta raiz. Permissões necessárias: Read-Only ativos, Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Referência da pasta pai
|
root | string |
Referência da pasta pai |
|
|
Profundidade máxima da pasta a percorrer, Padrão 2
|
maxDepth | integer |
Profundidade máxima da pasta a percorrer, Padrão 2 |
|
|
Número máximo de pastas a serem retornadas. Padrão 20, máximo 200
|
maxReturn | integer |
Número máximo de pastas a serem retornadas. Padrão 20, máximo 200 |
|
|
Deslocamento inteiro para paginação. Padrão 0
|
offset | integer |
Deslocamento inteiro para paginação. Padrão 0 |
|
|
Nome do espaço de trabalho
|
workSpace | string |
Nome do espaço de trabalho |
Devoluções
Obter programa por id
Recupera o registro do programa para a id fornecida. Permissões necessárias: Read-Only Ativos, Read-Write Ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
Devoluções
Obter programa por nome
Recupera o registro do programa para o nome fornecido. Permissões necessárias: Read-Only ativos, Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do programa
|
name | True | string |
Nome do programa |
|
Definir true para preencher tags de programa
|
includeTags | boolean |
Definir true para preencher tags de programa |
|
|
Definir true para preencher os custos do programa
|
includeCosts | boolean |
Definir true para preencher os custos do programa |
Devoluções
Obter Programas
Recupera a lista de programas acessíveis da instância de destino. Permissões necessárias: Read-Only ativos, Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número máximo de canais a devolver. Max 200, padrão 20
|
maxReturn | integer |
Número máximo de canais a devolver. Max 200, padrão 20 |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
Filtro opcional. Requer filterValues
|
filterType | string |
Filtro opcional. Requer filterValues |
|
|
Excluir programas anteriores a esta data. Consulte Descrição do tipo de campo Data/hora.
|
earliestUpdatedAt | string |
Excluir programas anteriores a esta data. Deve ser válido ISO-8601 string. Consulte Descrição do tipo de campo Data/hora . |
|
|
Excluir programas após esta data. Consulte Descrição do tipo de campo Data/hora.
|
latestUpdatedAt | string |
Excluir programas após esta data. Deve ser válido ISO-8601 string. Consulte Descrição do tipo de campo Data/hora . |
Devoluções
Obter programas por tag
Recupera uma lista de programas que correspondem ao tipo de tag e aos valores de tag fornecidos. Permissões necessárias: Read-Only ativos, Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de tag de programa
|
tagType | True | string |
Tipo de tag de programa |
|
Valor da tag
|
tagValue | True | string |
Valor da tag |
|
Número máximo de canais a devolver. Max 200, padrão 20
|
maxReturn | integer |
Número máximo de canais a devolver. Max 200, padrão 20 |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
Devoluções
Obter status de lead de importação
Retorna o status de um trabalho em lote de importação. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho de lote de importação.
|
batchId | True | integer |
Id do trabalho de lote de importação. |
Devoluções
Obter status de membro do programa de importação
Retorna o status de um trabalho em lote de importação. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho de lote de importação.
|
batchId | True | integer |
Id do trabalho de lote de importação. |
Devoluções
Obter status de trabalho de lead de exportação
Retorna o status de um trabalho de exportação. O status do trabalho fica disponível por 30 dias após o status Concluído ou Reprovado ter sido atingido. Permissões necessárias: Read-Only Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho em lote de exportação.
|
exportId | True | string |
Id do trabalho em lote de exportação. |
Devoluções
Obter status de trabalho de membro do programa de exportação
Retorna o status de um trabalho de exportação. O status do trabalho fica disponível por 30 dias após o status Concluído ou Reprovado ter sido atingido. Permissões necessárias: Read-Only Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho em lote de exportação.
|
exportId | True | string |
Id do trabalho em lote de exportação. |
Devoluções
Obter trabalhos de lead de exportação
Retorna uma lista de trabalhos de exportação que foram criados nos últimos 7 dias. Permissões necessárias: Read-Only Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lista separada por vírgulas de status para filtrar.
|
status | array |
Lista separada por vírgulas de status para filtrar. |
|
|
O tamanho do lote a ser retornado. O valor máximo e padrão é 300.
|
batchSize | integer |
O tamanho do lote a ser retornado. O valor máximo e padrão é 300. |
|
|
O token da próxima página
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
Devoluções
Obter vagas de membro do programa de exportação
Retorna uma lista de trabalhos de exportação que foram criados nos últimos 7 dias. Permissões necessárias: Read-Only Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lista separada por vírgulas de status para filtrar.
|
status | array |
Lista separada por vírgulas de status para filtrar. |
|
|
O tamanho do lote a ser retornado. O valor máximo e padrão é 300.
|
batchSize | integer |
O tamanho do lote a ser retornado. O valor máximo e padrão é 300. |
|
|
Será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote.
|
nextPageToken | string |
Um token será retornado por este ponto de extremidade se o conjunto de resultados for maior do que o tamanho do lote e puder ser passado em uma chamada subsequente por meio desse parâmetro. Consulte Tokens de paginação para obter mais informações. |
Devoluções
Programa Clone
Clones o programa alvo. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
|
descrição
|
description | string | ||
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
|
nome
|
name | True | string |
Nome do programa. Max 255 caracteres |
Devoluções
Programa de reprovação
Não aprova o programa-alvo. Válido apenas para programas de e-mail aprovados. Permissões necessárias: Read-Write ativos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
Devoluções
- Body
- ResponseOfIdResponse
Remover da lista
Remove um determinado conjunto de registros de pessoas de uma lista estática de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id da lista estática para remover leads de
|
listId | True | integer |
Id da lista estática para remover leads de |
|
id
|
id | True | integer |
ID inteiro exclusivo de um registro de lead |
|
id
|
id | True | array |
id |
Devoluções
Sincronizar dados de membros do programa
Altera os dados do membro do programa de uma lista de leads em um programa de destino. Apenas os membros existentes do programa podem ter os seus dados alterados com esta API. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id do programa de destino.
|
programId | True | integer |
O id do programa de destino. |
|
leadId
|
leadId | True | integer |
ID inteiro exclusivo de um registro de lead |
|
{fieldApiName}
|
{fieldApiName} | True | string |
Nome da API do campo a ser atualizado. Deve ser atualizável conforme descrito pelo ponto de extremidade Descrever Membro do Programa . |
|
{fieldApiName2}
|
{fieldApiName2} | string |
Nome da API de outro campo a ser atualizado (e assim por diante). Deve ser atualizável conforme descrito pelo ponto de extremidade Descrever Membro do Programa . |
Devoluções
Sincronizar leads
Sincroniza uma lista de leads com a instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ação
|
action | string |
Tipo de operação de sincronização a ser executada. O padrão é createOrUpdate se não estiver definido |
|
|
asyncProcessing
|
asyncProcessing | boolean |
Se definido como true, a chamada retornará imediatamente |
|
|
id
|
id | integer |
ID inteiro exclusivo de um registro de lead |
|
|
adquirida por
|
acquiredBy | boolean |
Se o lead foi adquirido pelo programa pai |
|
|
isEsgotado
|
isExhausted | boolean |
Se o chumbo está atualmente esgotado no fluxo, se aplicável |
|
|
membershipDate
|
membershipDate | True | string |
Data em que o lead se tornou membro do programa pela primeira vez |
|
nutrirCadência
|
nurtureCadence | string |
Cadência do fluxo pai, se aplicável |
|
|
progressãoStatus
|
progressionStatus | True | string |
Status do programa do lead no programa pai |
|
alcançadoSucesso
|
reachedSuccess | boolean |
Se o lead está em um status de sucesso no programa pai |
|
|
fluxo
|
stream | string |
Transmitir do qual o lead é membro, se o programa pai for um programa de engajamento |
|
|
código
|
code | True | string |
Código inteiro do motivo |
|
mensagem
|
message | True | string |
Mensagem descrevendo o motivo do status da operação |
|
estado
|
status | string |
Estado da operação realizada no registo |
|
|
lookupField
|
lookupField | string |
Campo para desduplicar. O campo deve estar presente em cada registro de lead da entrada. Padrão para e-mail se não estiver definido |
|
|
nome_da_partição
|
partitionName | string |
Nome da partição a operar, se aplicável. Deve ser definido sempre que possível, ao interagir com uma instância onde as partições estão habilitadas. |
Devoluções
- Body
- ResponseOfLead
Sincronizar status de membro do programa
Altera o status de membro do programa de uma lista de leads em um programa de destino. Se o membro não fizer parte do programa, o membro será adicionado ao programa. Permissões necessárias: Read-Write Lead
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id do programa de destino.
|
programId | True | integer |
O id do programa de destino. |
|
statusNome
|
statusName | True | string |
Status de membro do programa |
|
leadId
|
leadId | True | integer |
ID inteiro exclusivo de um registro de lead |
Devoluções
Solicitar Campanha
Passa um conjunto de leads para uma campanha de gatilho para percorrer o fluxo da campanha. A campanha designada deve ter um gatilho Campaign is Requested: Web Service API e deve estar ativa. Meus tokens locais para o programa pai da campanha podem ser substituídos para a execução para personalizar o conteúdo. É permitido um máximo de 100 leads por chamada. Permissões necessárias: Executar campanha
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id da campanha para desencadear
|
campaignId | True | integer |
O id da campanha para desencadear |
|
id
|
id | True | integer |
ID inteiro exclusivo de um registro de lead |
|
nome
|
name | True | string |
Nome do token. Deve ser formatado como "{{my.name}}" |
|
valor
|
value | True | string |
Valor do token |
Devoluções
- Body
- ResponseOfCampaign
Trabalho de Membro do Programa de Exportação de Enfila
Enfileirar trabalho de exportação. Isso colocará o trabalho de exportação na fila e iniciará o trabalho quando os recursos de computação estiverem disponíveis. O trabalho de exportação deve estar no estado "Criado".
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id do trabalho em lote.
|
exportId | True | string |
Id do trabalho em lote de exportação. |
Devoluções
Definições
ResponseOfIdentity
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
access_token
|
access_token | string |
O token que você passa com chamadas subsequentes para autenticar com a instância de destino |
|
âmbito
|
scope | string |
O usuário proprietário somente API do serviço personalizado que foi usado para autenticar |
|
expires_in
|
expires_in | integer |
Vida útil restante do token atual em segundos |
|
token_type
|
token_type | string |
O método de autenticação OAuth |
ResponseOfStaticList
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of StaticList |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
Liderança
Registo de leads. Sempre contém id, mas pode ter qualquer número de outros campos, dependendo dos campos disponíveis na instância de destino.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID inteiro exclusivo de um registro de lead |
|
associação
|
membership | ProgramMembership | |
|
razão
|
reason | Reason | |
|
estado
|
status | string |
Estado da operação realizada no registo |
Campo de Chumbo
Registro de campo de chumbo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string |
Nome de exibição da interface do usuário do campo |
|
nome
|
name | string |
Nome da API do campo |
|
descrição
|
description | string |
Descrição do campo |
|
Tipo de dados
|
dataType | string |
Tipo de dados do campo |
|
length
|
length | integer |
Comprimento máximo do campo. Aplicável apenas a texto, cadeia de caracteres e área de texto. |
|
isHidden
|
isHidden | boolean |
Se definido como true, o campo fica oculto |
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Se definido como true, o campo é codificado como HTML no e-mail |
|
isSensitive
|
isSensitive | boolean |
Se definido como true, o campo será marcado como sensível |
|
isCustom
|
isCustom | boolean |
Se definido como true, o campo é personalizado |
|
isApiCreated
|
isApiCreated | boolean |
Se definido como true, o campo foi criado usando a API REST |
LeadFieldStatus
Status de atualização do campo de lead
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da API do campo |
|
estado
|
status | string |
Estado da operação realizada no registo |
ListOperationOutputData
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID inteiro exclusivo de um registro de lead |
|
Razões
|
reasons | array of Reason |
Lista de razões pelas quais uma operação não foi bem-sucedida. Os motivos estão presentes apenas nas respostas da API e não devem ser enviados |
|
estado
|
status | string |
Estado da operação realizada no registo |
LeadAttribute
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de dados
|
dataType | string |
Tipo de dados do campo |
|
nome de exibição
|
displayName | string |
Nome de exibição da interface do usuário do campo |
|
id
|
id | integer |
ID inteiro exclusivo do campo |
|
length
|
length | integer |
Comprimento máximo do campo. Aplicável apenas a texto, cadeia de caracteres e área de texto. |
|
descanso
|
rest | LeadMapAttribute | |
|
sabonete
|
soap | LeadMapAttribute |
LeadAttribute2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
"API Lead" |
|
pesquisávelCampos
|
searchableFields | array of LeadAttribute2SearchableFields |
Lista de campos pesquisáveis |
|
campos
|
fields | array of LeadAttribute2Fields |
Descrição dos campos pesquisáveis |
LeadAttribute2SearchableFields
Lista de campos pesquisáveis
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
string |
Campo pesquisável |
LeadAttribute2Fields
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do campo da API REST |
|
nome de exibição
|
displayName | string |
Nome de exibição do campo (nome amigável) |
|
Tipo de dados
|
dataType | string |
Tipo de dados do campo |
|
length
|
length | integer |
Comprimento do campo |
|
updateable
|
updateable | boolean |
O campo é atualizável |
|
crmGerenciado
|
crmManaged | boolean |
É gerenciado pelo CRM |
LeadAttribute2Fields2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do campo da API REST |
|
nome de exibição
|
displayName | string |
Nome de exibição do campo (nome amigável) |
|
Tipo de dados
|
dataType | string |
Tipo de dados do campo |
|
length
|
length | integer |
Comprimento do campo |
|
updateable
|
updateable | boolean |
O campo é atualizável |
|
crmGerenciado
|
crmManaged | boolean |
É gerenciado pelo CRM |
ProgramMemberAttribute
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
"Membro do Programa API" |
|
campos
|
fields | array of LeadAttribute2Fields |
Descrição dos campos pesquisáveis |
ProgramMemberAttribute2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
"Membro do Programa API" |
|
descrição
|
description | string |
"Mapa de Membros do Programa API" |
|
criadosAt
|
createdAt | string |
Data/hora quando criado |
|
atualizadoem
|
updatedAt | string |
Data/hora atualizada |
|
dedupeFields
|
dedupeFields | array of string |
Lista de campos de duplicação |
|
pesquisávelCampos
|
searchableFields | array of LeadAttribute2SearchableFields |
Lista de campos pesquisáveis |
|
campos
|
fields | array of LeadAttribute2Fields2 |
Descrição dos campos pesquisáveis |
ResponseOfImportLeadResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ImportLeadResponse |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ImportProgramMemberResponse
Resposta contendo informações de status de importação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
batchId
|
batchId | integer |
ID inteiro exclusivo do trabalho de importação |
|
importId
|
importId | string |
ID inteiro exclusivo do trabalho de importação |
|
estado
|
status | string |
Status do trabalho de importação |
ResponseOfImportProgramMemberResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ImportProgramMemberResponse |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
RespostadeCampanha
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of Campaign |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfListOperationOutputData
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ListOperationOutputData |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
Campanha
Registro de uma campanha Marketo Smart
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
active
|
active | boolean |
Se a campanha está ativa. Aplicável apenas a campanhas de gatilho |
|
criadosAt
|
createdAt | string |
Data/hora em que a campanha foi criada |
|
descrição
|
description | string |
Descrição da Campanha Inteligente |
|
id
|
id | integer |
ID inteiro exclusivo da Campanha Inteligente |
|
nome
|
name | string |
Nome da Campanha Inteligente |
|
Id do programa
|
programId | integer |
Id do programa pai, se aplicável |
|
nomedoprograma
|
programName | string |
Nome do programa pai, se aplicável |
|
tipo
|
type | string |
Tipo de campanha inteligente |
|
atualizadoem
|
updatedAt | string |
Data/hora em que a campanha foi atualizada mais recentemente |
|
nome do espaço de trabalho
|
workspaceName | string |
Nome do espaço de trabalho pai, se aplicável |
RespostadeLead
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of Lead |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfLeadByListId
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of Lead |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfLeadField
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of LeadField |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfUpdateLeadField
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of LeadFieldStatus |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
RespostaDePushLeadToMarketo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of Lead |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfLeadAttribute
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of LeadAttribute |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfLeadAttribute2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of LeadAttribute2 |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfProgramMemberAttributes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ProgramMemberAttribute |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfProgramMemberAttributes2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ProgramMemberAttribute2 |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
Advertência
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | integer |
Código inteiro do aviso |
|
mensagem
|
message | string |
Mensagem descrevendo o aviso |
ResponseOfExportResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ExportResponse |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfExportResponseWithToken
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ExportResponse |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfProgramMember
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ProgramMember |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
Membro do Programa
Registo de membro do programa. Sempre contém id de lead, mas pode ter qualquer número de outros campos, dependendo dos campos disponíveis na instância de destino.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
seq
|
seq | integer |
Inteiro indicando a sequência do registro em resposta. Esse valor está correlacionado com a ordem dos registros incluídos na entrada da solicitação. Seq deve ser apenas parte das respostas e não deve ser enviado. |
|
leadId
|
leadId | integer |
ID inteiro exclusivo de um registro de lead |
|
alcançadoSucesso
|
reachedSuccess | boolean |
Booleano indicando se o membro do programa atingiu os critérios de sucesso para o programa |
|
Id do programa
|
programId | integer |
ID inteiro exclusivo de um programa |
|
adquirida por
|
acquiredBy | boolean |
Booleano indicando se o membro do programa foi adquirido pelo programa |
|
membershipDate
|
membershipDate | string |
Data em que o lead se tornou membro do programa pela primeira vez |
ResponseOfProgramMemberStatus
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ProgramMemberStatusResponse |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfProgramMemberData
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ProgramMemberStatusResponse |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ResponseOfProgramMemberDelete
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error |
Matriz de erros que ocorreram se a solicitação não foi bem-sucedida |
|
maisResultado
|
moreResult | boolean |
Booleano indicando se há mais resultados nas páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho de lote permitido |
|
requestId
|
requestId | string |
ID do pedido efetuado |
|
Resultado
|
result | array of ProgramMemberDeleteResponse |
Matriz de resultados para registros individuais na operação, pode estar vazio |
|
sucesso
|
success | boolean |
Se o pedido foi bem-sucedido |
|
Advertências
|
warnings | array of Warning |
Conjunto de avisos dados para a operação |
ImportLeadResponse
Resposta contendo informações de status de importação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
batchId
|
batchId | integer |
ID inteiro exclusivo do lote de importação |
|
importId
|
importId | string | |
|
mensagem
|
message | string | |
|
numOfLeadsProcessed
|
numOfLeadsProcessed | integer |
Número de linhas processadas até à data |
|
numOfRowsFailed
|
numOfRowsFailed | integer |
Número de linhas falhadas até agora |
|
numOfRowsWithWarning
|
numOfRowsWithWarning | integer |
Número de linhas com um aviso até agora |
|
estado
|
status | string |
Estado do lote |
Adesão ao Programa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
adquirida por
|
acquiredBy | boolean |
Se o lead foi adquirido pelo programa pai |
|
isEsgotado
|
isExhausted | boolean |
Se o chumbo está atualmente esgotado no fluxo, se aplicável |
|
membershipDate
|
membershipDate | string |
Data em que o lead se tornou membro do programa pela primeira vez |
|
nutrirCadência
|
nurtureCadence | string |
Cadência do fluxo pai, se aplicável |
|
progressãoStatus
|
progressionStatus | string |
Status do programa do lead no programa pai |
|
alcançadoSucesso
|
reachedSuccess | boolean |
Se o lead está em um status de sucesso no programa pai |
|
fluxo
|
stream | string |
Transmitir do qual o lead é membro, se o programa pai for um programa de engajamento |
ExportResponse
Resposta contendo informações de status do trabalho de exportação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
criadosAt
|
createdAt | date-time |
Data em que a solicitação de exportação foi criada |
|
erroMsg
|
errorMsg | string |
Mensagem de erro em caso de status "Falha" |
|
exportId
|
exportId | string |
ID exclusivo do trabalho de exportação |
|
tamanho do ficheiro
|
fileSize | integer |
Tamanho do arquivo exportado em bytes. Isso terá um valor somente quando o status for "Concluído", caso contrário, nulo |
|
fileChecksum
|
fileChecksum | string |
SHA-256 hash do arquivo exportado. Isso terá um valor somente quando o status for "Concluído", caso contrário, nulo |
|
FinalizadoEm
|
finishedAt | date-time |
Hora de término do trabalho de exportação. Isso terá valor somente quando o status for "Concluído" ou "Falhado", caso contrário, nulo |
|
format
|
format | string |
Formato do ficheiro indicado no pedido ("CSV", "TSV", "SSV") |
|
númeroderegistos
|
numberOfRecords | integer |
Número de registros no arquivo de exportação. Isso terá valor somente quando o status for "Concluído", caso contrário, nulo |
|
em fila.
|
queuedAt | date-time |
Tempo de fila do trabalho de exportação. Isso terá valor quando o status "Enfileirado" for atingido, antes que null |
|
começouEm
|
startedAt | date-time |
Hora de início do trabalho de exportação. Isso terá valor quando o status "Processamento" for atingido, antes que null |
|
estado
|
status | string |
Status do trabalho de exportação ("Criado","Enfileirado","Processamento","Cancelado","Concluído","Falha") |
Reason
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
Código inteiro do motivo |
|
mensagem
|
message | string |
Mensagem descrevendo o motivo do status da operação |
LeadMapAttribute
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do atributo |
|
somente leitura
|
readOnly | boolean |
Se o atributo é somente leitura |
Erro
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
Código de erro do erro. Veja a lista completa de códigos de erro aqui |
|
mensagem
|
message | string |
Mensagem descrevendo a causa do erro |
ProgramMemberStatusResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
estado
|
status | string |
Estado da operação realizada no registo |
|
Razões
|
reasons | array of Reason |
Lista de razões pelas quais uma operação não foi bem-sucedida. Os motivos estão presentes apenas nas respostas da API e não devem ser enviados |
|
leadId
|
leadId | integer |
ID do lead associado ao membro do programa |
|
seq
|
seq | integer |
Inteiro indicando a sequência do registro em resposta. Esse valor está correlacionado com a ordem dos registros incluídos na entrada da solicitação. Seq deve ser apenas parte das respostas e não deve ser enviado. |
ProgramMemberDeleteResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
estado
|
status | string |
Estado da operação realizada no registo |
|
Razões
|
reasons | array of Reason |
Lista de razões pelas quais uma operação não foi bem-sucedida. Os motivos estão presentes apenas nas respostas da API e não devem ser enviados |
|
leadId
|
leadId | integer |
ID do lead associado ao membro do programa |
|
seq
|
seq | integer |
Inteiro indicando a sequência do registro em resposta. Esse valor está correlacionado com a ordem dos registros incluídos na entrada da solicitação. Seq deve ser apenas parte das respostas e não deve ser enviado. |
Lista Estática
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
criadosAt
|
createdAt | string |
Data/hora em que a lista foi criada |
|
descrição
|
description | string |
Descrição da lista estática |
|
id
|
id | integer |
ID inteiro exclusivo da lista estática |
|
nome
|
name | string |
Nome da lista estática |
|
nomedoprograma
|
programName | string |
Nome do programa |
|
atualizadoem
|
updatedAt | string |
Data/hora em que a lista foi atualizada mais recentemente |
|
nome do espaço de trabalho
|
workspaceName | string |
Nome do espaço de trabalho pai, se aplicável |
BrowseAllProgramas
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
canal
|
channel | string |
Canal do programa |
|
criadosAt
|
createdAt | date-time |
Data/hora em que o ativo foi criado |
|
descrição
|
description | string |
Descrição do ativo |
|
pasta
|
folder | Folder |
Representação JSON de uma pasta |
|
id
|
id | integer |
ID do ativo |
|
nome
|
name | string |
Nome do ativo |
|
sfdcId
|
sfdcId | string |
ID SFDC do programa se vinculado a uma campanha SFDC |
|
sfdcNome
|
sfdcName | string |
Nome da campanha SFDC associada, se aplicável |
|
estado
|
status | string |
Status do programa. Válido apenas para os tipos de programa de e-mail e engajamento. |
|
tipo
|
type | string |
Tipo de programa |
|
atualizadoem
|
updatedAt | date-time |
Data/hora em que o ativo foi atualizado mais recentemente |
|
URL
|
url | string |
URL do ativo na UI do Marketo |
|
área de trabalho
|
workspace | string |
Nome do espaço de trabalho |
FolderContentResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
tipo
|
type | string |
FileFolder
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string | |
|
tipo
|
type | string |
ResponseOfProgramResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of ProgramResponse | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
ResponseOfSmartListResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of SmartListResponse | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
ResponseOfSmartListResponseWithRules
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of SmartListResponseWithRules | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
SmartListResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID da lista inteligente |
|
nome
|
name | string |
Nome da lista inteligente |
|
descrição
|
description | string |
Descrição da lista inteligente |
|
criadosAt
|
createdAt | date-time |
Data/hora em que a lista inteligente foi criada |
|
atualizadoem
|
updatedAt | date-time |
Data/hora em que a lista inteligente foi atualizada mais recentemente |
|
URL
|
url | string |
URL da lista inteligente na interface do usuário do Marketo |
|
pasta
|
folder | Folder |
Representação JSON de uma pasta |
|
área de trabalho
|
workspace | string |
Nome do espaço de trabalho |
SmartListResponseWithRules
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID da lista inteligente |
|
nome
|
name | string |
Nome da lista inteligente |
|
descrição
|
description | string |
Descrição da lista inteligente |
|
criadosAt
|
createdAt | date-time |
Data/hora em que a lista inteligente foi criada |
|
atualizadoem
|
updatedAt | date-time |
Data/hora em que a lista inteligente foi atualizada mais recentemente |
|
URL
|
url | string |
URL da lista inteligente na interface do usuário do Marketo |
|
pasta
|
folder | Folder |
Representação JSON de uma pasta |
|
área de trabalho
|
workspace | string |
Nome do espaço de trabalho |
|
rules
|
rules | SmartListRules |
Representação JSON de regras de lista inteligente |
ResponseOfStaticListResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of StaticListResponse | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
StaticListResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Id da lista estática |
|
nome
|
name | string |
Nome da lista estática |
|
descrição
|
description | string |
Descrição da lista estática |
|
criadosAt
|
createdAt | date-time |
Data/hora em que a lista estática foi criada |
|
atualizadoem
|
updatedAt | date-time |
Data/hora em que a lista estática foi atualizada mais recentemente |
|
URL
|
url | string |
URL da lista estática na interface do usuário do Marketo |
|
pasta
|
folder | Folder |
Representação JSON de uma pasta |
|
área de trabalho
|
workspace | string |
Nome do espaço de trabalho |
|
computedUrl
|
computedUrl | string |
Resposta do Programa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
canal
|
channel | string |
Canal do programa |
|
costs
|
costs | array of Costs |
Listas de custos de período associados |
|
criadosAt
|
createdAt | date-time |
Data/hora em que o ativo foi criado |
|
descrição
|
description | string |
Descrição do ativo |
|
data de término
|
endDate | date-time |
Data de fim do programa. Aplicável a programas do tipo evento, e-mail e webinar |
|
pasta
|
folder | ProgramFolder | |
|
id
|
id | integer |
ID do ativo |
|
nome
|
name | string |
Nome do ativo |
|
sfdcId
|
sfdcId | string |
ID SFDC do programa se vinculado a uma campanha SFDC |
|
sfdcNome
|
sfdcName | string |
Nome da campanha SFDC associada, se aplicável |
|
startDate
|
startDate | date-time |
Data de início do programa. Aplicável a programas do tipo evento, e-mail e webinar |
|
estado
|
status | string |
Status do programa. Válido apenas para os tipos de programa de e-mail e engajamento. |
|
tags
|
tags | array of Tags |
Lista de tags de programa associadas |
|
tipo
|
type | string |
Tipo de programa |
|
atualizadoem
|
updatedAt | date-time |
Data/hora em que o ativo foi atualizado mais recentemente |
|
URL
|
url | string |
URL do ativo na UI do Marketo |
|
área de trabalho
|
workspace | string |
Nome do espaço de trabalho |
|
marketingProgramProgressionId
|
marketingProgramProgressionId | integer | |
|
headStart [en]
|
headStart | boolean |
Se a função 'Head Start' está ativada para o programa |
FileResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
criadosAt
|
createdAt | date-time |
Data/hora em que o arquivo foi criado |
|
descrição
|
description | string |
Descrição do ficheiro |
|
pasta
|
folder | FileFolder | |
|
id
|
id | integer |
ID do ficheiro |
|
mimeType
|
mimeType | string |
Tipo MIME do ficheiro |
|
nome
|
name | string |
Nome do ficheiro |
|
size
|
size | integer |
Tamanho do ficheiro em bytes |
|
atualizadoem
|
updatedAt | date-time |
Data/hora em que o arquivo foi atualizado mais recentemente |
|
URL
|
url | string |
URL do ficheiro acessível ao público |
ResponseOfFileResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of FileResponse | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
FolderResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
accessZoneId
|
accessZoneId | integer | |
|
criadosAt
|
createdAt | date-time |
Data/hora em que a pasta foi criada |
|
descrição
|
description | string |
Descrição da pasta |
|
folderId
|
folderId | Folder |
Representação JSON de uma pasta |
|
Tipo de pasta
|
folderType | string |
Tipo de pasta |
|
id
|
id | integer |
ID da pasta |
|
isArquivo
|
isArchive | boolean |
Status de arquivamento da pasta |
|
isSystem
|
isSystem | boolean |
Se a pasta é gerenciada pelo sistema |
|
nome
|
name | string |
Nome da pasta. Não aplicável a Programas |
|
elemento principal
|
parent | Folder |
Representação JSON de uma pasta |
|
caminho
|
path | string |
Caminho da pasta |
|
atualizadoem
|
updatedAt | date-time |
Data/hora em que a pasta foi atualizada pela última vez |
|
URL
|
url | string |
URL da pasta |
|
área de trabalho
|
workspace | string |
Nome do espaço de trabalho |
ResponseOfIdResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of IdResponse | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
Etiquetas
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de etiqueta
|
tagType | string |
Nome da tag |
|
tagValue
|
tagValue | string |
Valor da tag |
ResponseOfBrowseAllProgramas
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of BrowseAllPrograms | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
ResponseOfFolderResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of FolderResponse | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
ResponseOfFolderContentResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Resultado
|
result | array of FolderContentResponse | |
|
sucesso
|
success | boolean | |
|
Advertências
|
warnings | array of string |
IdResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID do ativo |
Custos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
custo
|
cost | integer |
Montante do custo |
|
Observação
|
note | string |
Notas sobre o custo |
|
startDate
|
startDate | date-time |
Data de início do custo do período |
ProgramFolder
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string |
O tipo de pasta do programa |
|
valor
|
value | integer |
O id da pasta do programa |
|
folderName
|
folderName | string |
O nome da pasta do programa |
Folder
Representação JSON de uma pasta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID da pasta |
|
tipo
|
type | string |
Tipo de pasta |
SmartListRules
Representação JSON de regras de lista inteligente
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
filterMatchType
|
filterMatchType | string |
Tipo de correspondência de filtro de lista inteligente (lógica de regra) |
|
triggers
|
triggers | array of string |
Lista de gatilhos de lista inteligente |
|
filters
|
filters | array of SmartListFilters |
Lista de filtros de lista inteligente |
SmartListFilters
Representação JSON de filtros de lista inteligente
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID do filtro |
|
nome
|
name | string |
Nome do filtro |
|
ruleTypeId
|
ruleTypeId | integer |
ID do tipo de regra |
|
ruleType
|
ruleType | string |
Nome do tipo de regra |
|
operador
|
operator | string |
Nome do operador |
|
condições
|
conditions | array of SmartListConditions |
Lista de condições da lista inteligente |
SmartListCondições
Representação JSON das condições da lista inteligente
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
activityAttributeId
|
activityAttributeId | integer |
Id do atributo activity |
|
activityAttributeName
|
activityAttributeName | string |
Nome do atributo de atividade |
|
operador
|
operator | string |
Valor do operador |
|
values
|
values | array of string |
Lista de valores |
|
isPrimário
|
isPrimary | boolean |
Se a condição é primária ou não (primeira condição da lista inteligente) |
objecto
Este é o tipo 'objeto'.