Marketo MA (versão prévia)
Automação de Marketing do Marketo. Essa API fornece acesso a objetos marketo, como campanhas, programas, clientes potenciais, listas (estáticas e inteligentes), bem como ativos de sistema de arquivos, como arquivos e pastas.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | 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) |
| Power Automate | Standard | Todas as regiões do Power Automate , 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 do Marketo |
| URL | http://developers.marketo.com |
| developerfeedback@marketo.com |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft Inc. |
| Site | 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 |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| MunchkinID | cadeia | Seu Marketo MunchkinID (consulte a página Administrador) | Verdade |
| ID do cliente | cadeia | ID do cliente | Verdade |
| Segredo de Cliente | secureString | Segredo de Cliente | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar à Lista |
Adiciona um determinado conjunto de registros de pessoas a uma lista estática de destino. Há um limite de 300 IDs de lead por solicitação. Permissões necessárias: Read-Write Lead |
| Agendar Campanha |
Agenda remotamente uma campanha em lote a 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 de destino. Válido apenas para programas de email não aprovados. Permissões necessárias: ativos Read-Write |
| Atualizar campo de cliente potencial |
Atualize os metadados de um campo de cliente potencial na instância de destino. Veja as regras de atualização aqui. Permissões necessárias: Read-Write campo padrão de esquema, Read-Write campo personalizado de esquema |
| Atualizar conteúdo do arquivo |
Substitui o conteúdo atual do arquivo pelo conteúdo incluído. Permissões necessárias: ativos Read-Write |
| Atualizar marca de programa |
Atualizar marca de programa. Permissões necessárias: ativos Read-Write |
| Atualizar metadados de lista estática |
Atualiza os metadados de um ativo de lista estática. Permissões necessárias: ativos Read-Write |
| Atualizar metadados de pasta |
Atualiza os metadados de uma determinada pasta. Permissões necessárias: ativos Read-Write |
| Atualizar metadados do programa |
Atualiza os metadados do programa de destino. Permissões necessárias: ativos Read-Write |
| Campanha de solicitação |
Passa um conjunto de leads para uma campanha de gatilho para executar através do fluxo da campanha. A campanha designada deve ter uma campanha solicitada: gatilho de API de Serviço Web 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. Um máximo de 100 clientes potenciais são permitidos por chamada. Permissões necessárias: executar campanha |
| Cancelar o trabalho de cliente potencial de exportação |
Cancelar o trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Cancelar o trabalho de membro do programa de exportação |
Cancelar o trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Clientes potenciais de sincronização |
Sincroniza uma lista de clientes potenciais para a instância de destino. Permissões necessárias: Read-Write Lead |
| Clonar Lista Inteligente |
Clona a Lista Inteligente designada. Permissões necessárias: ativo Read-Write |
| Clonar Programa |
Clona o programa de destino. Permissões necessárias: ativos Read-Write |
| Criar arquivo |
Cria um novo arquivo com base no conteúdo incluído. Permissões necessárias: ativos Read-Write |
| Criar lista estática |
Cria uma nova Lista Estática. Permissões necessárias: ativos Read-Write |
| Criar pasta |
Cria uma nova pasta. Permissões necessárias: ativos Read-Write |
| Criar Programa |
Cria um novo programa. Permissões necessárias: ativos Read-Write |
| Criar trabalho de cliente potencial de exportação |
Crie um trabalho de exportação para critérios de pesquisa definidos por meio do parâmetro "filter". A solicitação retorna a "exportId" que é passada como um parâmetro em chamadas subsequentes para pontos de extremidade potenciais de exportação em massa. Use o ponto de extremidade do Enqueue Export Lead Job para enfileirar o trabalho de exportação para processamento. Use o ponto de extremidade Obter Status do Trabalho Potencial de Exportação 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 por meio do parâmetro "filter". A solicitação retorna a "exportId" que é passada como um parâmetro em chamadas subsequentes para pontos de extremidade membros do programa de exportação em massa. |
| 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 potenciais 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 Lead2 |
Retorna a lista de campos pesquisáveis em objetos potenciais na instância de destino. Permissões necessárias: Read-Only Lead, Read-Write Lead |
| Enqueue Export Lead Job |
Trabalho de exportação de enfileiramento. 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 Obter Status do Trabalho Potencial de Exportação para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Excluir Clientes Potenciais |
Exclua uma lista de clientes potenciais 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: ativo Read-Write |
| Excluir Lista Inteligente |
Exclui a Lista Inteligente designada. Permissões necessárias: ativo Read-Write |
| Excluir Marca de Programa |
Excluir marca de programa não necessária. Permissões necessárias: ativos Read-Write |
| 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: ativos Read-Write |
| Excluir Programa |
Exclui o programa de destino. O programa pode não conter nenhum ativo que esteja em uso fora do programa. Permissões necessárias: ativos Read-Write |
| Identidade |
Recupere um token de acesso do Marketo. As chamadas para esse ponto de extremidade não são contadas para o limite de chamadas à API. |
| Identidade |
Recupere um token de acesso do Marketo. As chamadas para esse ponto de extremidade não são contadas para o limite de chamadas à API. |
| Importar clientes potenciais |
Importa um arquivo que contém registros de dados para a instância de destino. Permissões necessárias: Read-Write Lead |
| Importar membros do programa |
Importa um arquivo que contém registros de dados para a instância de destino. Permissões necessárias: Read-Write Lead |
| Membro da lista |
Verifica se os clientes potenciais são membros de uma determinada lista estática. Permissões necessárias: Read-Write 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 Obter Status do Trabalho de Membro do Programa de Exportação 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: ativos Read-Only, ativos Read-Write |
| Obter arquivos |
Retorna os arquivos da pasta fornecida. Permissões necessárias: ativos Read-Only, ativos Read-Write |
| Obter avisos de importação de clientes potenciais |
Retorna a lista de avisos para o trabalho de importação em lote. Permissões necessárias: Read-Write Lead |
| Obter avisos de membro do programa de importação |
Retorna a lista de avisos para o trabalho de importação em lote. Permissões necessárias: Read-Write Lead |
| Obter campanha por ID |
Retorna o registro de uma campanha por sua ID. Permissões necessárias: campanhas de Read-Only, campanhas de Read-Write |
| Obter campanhas |
Retorna uma lista de registros de campanha. Permissões necessárias: campanhas Read-Only, campanhas de Read-Write |
| Obter campo de cliente potencial por nome |
Recupera metadados para um único campo de chumbo. Permissões necessárias: Read-Write campo padrão de esquema, Read-Write campo personalizado de esquema |
| 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 de esquema, Read-Write campo personalizado de esquema |
| Obter clientes potenciais por ID de lista |
Recupera registros de pessoa que são membros da lista estática fornecida. Permissões necessárias: Read-Only Lead, Read-Write Lead |
| Obter clientes potenciais por ID de lista |
Recupera registros de pessoa que são membros da lista estática fornecida. Permissões necessárias: Read-Only Lead, Read-Write Lead |
| Obter clientes potenciais por ID do programa |
Recupera uma lista de clientes potenciais que são membros do programa designado. Permissões necessárias: Read-Only Lead, Read-Write Lead |
| Obter clientes potenciais por tipo de filtro |
Retorna uma lista de até 300 clientes potenciais com base em uma lista de valores em um campo específico. Permissões necessárias: Read-Only Lead, Read-Write Lead |
| Obter conteúdo da pasta |
Retorna registros para o conteúdo de uma determinada pasta. Permissões necessárias: ativos Read-Only, ativos Read-Write |
| Obter falhas de cliente potencial de importação |
Retorna a lista de falhas para o trabalho de importação em lote. Permissões necessárias: Read-Write Lead |
| Obter falhas de membro do programa de importação |
Retorna a lista de falhas para o trabalho de importação em lote. Permissões necessárias: 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 ativo Read-Write |
| Obter lista estática por nome |
Recupera um registro de Lista Estática por seu nome. Permissões necessárias: ativo Read-Asset ou Read-Write |
| Obter Lista Inteligente por ID |
Recupera um registro de Lista Inteligente por sua ID. Permissões necessárias: Read-Asset ou ativo Read-Write |
| Obter Lista Inteligente por ID do Programa |
Recupera um registro de Lista Inteligente por sua ID do Programa de Email. Permissões necessárias: Read-Asset ou ativo Read-Write |
| Obter Lista Inteligente por Nome |
Recupera um registro de Lista Inteligente pelo nome. Permissões necessárias: ativo Read-Asset ou Read-Write |
| 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áticos 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: ativo Read-Asset ou Read-Write |
| Obter listas inteligentes |
Recupera uma lista de registros de Lista Inteligente criados pelo usuário. Permissões necessárias: ativo Read-Asset ou Read-Write |
| 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 membro do programa poderá ser processado pela solicitação. Permissões necessárias: Read-Only Lead, Read-Write Lead |
| Obter o arquivo de cliente potencial 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 Obter Status do Trabalho Potencial de Exportação para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead |
| Obter o cliente potencial 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 o status do cliente potencial de importação |
Retorna o status de um trabalho em lotes de importação. Permissões necessárias: Read-Write Lead |
| Obter o status do trabalho de cliente potencial de exportação |
Retorna o status de um trabalho de exportação. O status do trabalho está disponível por 30 dias depois que o status concluído ou com falha foi atingido. Permissões necessárias: Read-Only Lead |
| Obter o status do trabalho de membro do programa de exportação |
Retorna o status de um trabalho de exportação. O status do trabalho está disponível por 30 dias depois que o status concluído ou com falha foi atingido. Permissões necessárias: Read-Only Lead |
| Obter Pasta por ID |
Retorna o registro de 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: ativos Read-Only, ativos Read-Write |
| Obter Pastas |
Recupera pastas filho de dentro de uma determinada pasta raiz. Permissões necessárias: ativos Read-Only, ativos Read-Write |
| Obter Programa por ID |
Recupera o registro do programa para a ID fornecida. Permissões necessárias: ativos Read-Only, ativos Read-Write |
| Obter Programa por Nome |
Recupera o registro do programa para o nome fornecido. Permissões necessárias: ativos Read-Only, ativos Read-Write |
| Obter programas |
Recupera a lista de programas acessíveis da instância de destino. Permissões necessárias: ativos Read-Only, ativos Read-Write |
| Obter programas por marca |
Recupera uma lista de programas que correspondem ao tipo de marca e aos valores de marca fornecidos. Permissões necessárias: ativos Read-Only, ativos Read-Write |
| Obter status de membro do programa de importação |
Retorna o status de um trabalho em lotes de importação. Permissões necessárias: Read-Write Lead |
| Obter trabalhos 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 |
| Obter trabalhos potenciais 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 Desaplicativo |
Não aprova o programa de destino. Válido apenas para programas de email aprovados. Permissões necessárias: ativos Read-Write |
| Push Lead to Marketo |
Upserts um lead e gera um Push Lead para a atividade Marketo. Permissões necessárias: Read-Write Lead |
| 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 membro do programa |
Altera os dados de membro do programa de uma lista de clientes potenciais em um programa de destino. Somente os membros existentes do programa podem ter seus dados alterados com essa API. Permissões necessárias: Read-Write Lead |
| Status do Membro do Programa de Sincronização |
Altera o status do membro do programa de uma lista de clientes potenciais 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 |
| Trabalho de Membro do Programa de Exportação de Enfileiramento |
Trabalho de exportação de enfileiramento. 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 pessoas a uma lista estática de destino. Há um limite de 300 IDs de lead por solicitação. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de destino
|
listId | True | integer |
ID da lista de destino |
|
id
|
id | True | integer |
ID de inteiro exclusivo de um registro de lead |
|
Lista separada por vírgulas de IDs potenciais a serem adicionadas à lista
|
id | array |
Lista separada por vírgulas de IDs potenciais a serem adicionadas à lista |
Retornos
Agendar Campanha
Agenda remotamente uma campanha em lote a 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
| Nome | Chave | Obrigató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 snippets, notificações por push, mensagens no aplicativo, listas estáticas, relatórios e ativos sociais podem não ser clonados dessa forma |
|
|
runAt
|
runAt | date-time |
Datetime no qual executar a campanha. Se não estiver definido, 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}}" |
|
value
|
value | True | string |
Valor do token |
Retornos
- Corpo
- ResponseOfCampaign
Aprovar Programa
Aprova o programa de destino. Válido apenas para programas de email não aprovados. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
Retornos
- Corpo
- ResponseOfIdResponse
Atualizar campo de cliente potencial
Atualize os metadados de um campo de cliente potencial na instância de destino. Veja as regras de atualização aqui. Permissões necessárias: Read-Write campo padrão de esquema, Read-Write campo personalizado de esquema
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O nome da API do campo de potencial
|
fieldApiName | True | string |
O nome da API do campo de potencial |
|
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 ficará oculto. O padrão é falso |
|
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Se definido como true, o campo será codificado como HTML no email. O padrão é true |
|
|
isSensitive
|
isSensitive | boolean |
Se definido como true, o campo será marcado como sensível. O padrão é falso |
Retornos
Atualizar conteúdo do arquivo
Substitui o conteúdo atual do arquivo pelo conteúdo incluído. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do arquivo
|
id | True | integer |
ID do arquivo no banco de dados |
|
arquivo
|
file | True | string |
Arquivo multipart. Conteúdo do arquivo. |
|
id
|
id | True | integer |
ID do arquivo |
Retornos
- Corpo
- ResponseOfFileResponse
Atualizar marca de programa
Atualizar marca de programa. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
|
Tipo de marca de programa
|
tagType | True | string |
Tipo de marca de programa |
|
Valor da marca de programa
|
tagValue | True | string |
Valor da marca de programa |
Retornos
- Corpo
- ResponseOfIdResponse
Atualizar metadados de lista estática
Atualiza os metadados de um ativo de lista estática. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
Atualizar metadados de pasta
Atualiza os metadados de uma determinada pasta. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID da pasta a ser atualizada
|
id | True | integer |
ID da pasta a ser atualizada |
|
descrição
|
description | string |
Descrição do ativo |
|
|
isArchive
|
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. 'Folder' ou 'Program' |
Retornos
- Corpo
- ResponseOfFolderResponse
Atualizar metadados do programa
Atualiza os metadados do programa de destino. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
|
custar
|
cost | True | integer |
Valor do custo |
|
nota
|
note | string |
Anotações sobre o custo |
|
|
startDate
|
startDate | True | date-time |
Data de início do custo do período |
|
costsDestructiveUpdate
|
costsDestructiveUpdate | boolean |
Definir 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 término do programa. Aplicável a programas de tipo de evento, email e webinar |
|
|
nome
|
name | string |
Nome do programa |
|
|
startDate
|
startDate | string |
Data de início do programa. Aplicável a programas de tipo de evento, email e webinar |
|
|
tagType
|
tagType | string |
Tipo de marca de programa |
|
|
tagValue
|
tagValue | string |
Valor da marca |
Retornos
Campanha de solicitação
Passa um conjunto de leads para uma campanha de gatilho para executar através do fluxo da campanha. A campanha designada deve ter uma campanha solicitada: gatilho de API de Serviço Web 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. Um máximo de 100 clientes potenciais são permitidos por chamada. Permissões necessárias: executar campanha
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID da campanha a ser disparada
|
campaignId | True | integer |
A ID da campanha a ser disparada |
|
id
|
id | True | integer |
ID de inteiro exclusivo de um registro de lead |
|
nome
|
name | True | string |
Nome do token. Deve ser formatado como "{{my.name}}" |
|
value
|
value | True | string |
Valor do token |
Retornos
- Corpo
- ResponseOfCampaign
Cancelar o trabalho de cliente potencial de exportação
Cancelar o trabalho de exportação. Permissões necessárias: Read-Only Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho em lote de exportação.
|
exportId | True | string |
ID do trabalho em lote de exportação. |
Retornos
- Corpo
- ResponseOfExportResponse
Cancelar o trabalho de membro do programa de exportação
Cancelar o trabalho de exportação. Permissões necessárias: Read-Only Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho em lote de exportação.
|
exportId | True | string |
ID do trabalho em lote de exportação. |
Retornos
- Corpo
- ResponseOfExportResponse
Clientes potenciais de sincronização
Sincroniza uma lista de clientes potenciais para a instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ação
|
action | string |
Tipo de operação de sincronização a ser executada. Padrões para criarOrUpdate se não definido |
|
|
asyncProcessing
|
asyncProcessing | boolean |
Se definido como true, a chamada retornará imediatamente |
|
|
id
|
id | integer |
ID de inteiro exclusivo de um registro de lead |
|
|
acquiredBy
|
acquiredBy | boolean |
Se o cliente potencial foi adquirido pelo programa pai |
|
|
isExhausted
|
isExhausted | boolean |
Se o lead está esgotado no momento no fluxo, se aplicável |
|
|
membershipDate
|
membershipDate | True | string |
Data em que o líder se tornou um membro do programa |
|
nurtureCadence
|
nurtureCadence | string |
Cadência do fluxo pai, se aplicável |
|
|
progressStatus
|
progressionStatus | True | string |
Status do programa do cliente potencial no programa pai |
|
reachedSuccess
|
reachedSuccess | boolean |
Se o cliente potencial está em um status de sucesso no programa pai |
|
|
fluxo
|
stream | string |
Transmitir do qual o cliente potencial é membro, se o programa pai for um programa de engajamento |
|
|
codificar
|
code | True | string |
Código inteiro do motivo |
|
mensagem
|
message | True | string |
Mensagem que descreve o motivo do status da operação |
|
status
|
status | string |
Status da operação executada no registro |
|
|
lookupField
|
lookupField | string |
Campo para eliminação de duplicação. O campo deve estar presente em cada registro de cliente potencial da entrada. O padrão é enviar email se não estiver definido |
|
|
partitionName
|
partitionName | string |
Nome da partição na qual operar, se aplicável. Deve ser definido sempre que possível, ao interagir com uma instância em que as partições estão habilitadas. |
Retornos
- Corpo
- ResponseOfLead
Clonar Lista Inteligente
Clona a Lista Inteligente designada. Permissões necessárias: ativo Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista inteligente a ser clonada
|
id | True | integer |
ID da lista inteligente a ser clonada |
|
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 |
Retornos
Clonar Programa
Clona o programa de destino. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigató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. Máximo de 255 caracteres |
Retornos
Criar arquivo
Cria um novo arquivo com base no conteúdo incluído. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string |
Descrição do ativo |
|
|
arquivo
|
file | True | string |
Arquivo multipart. Conteúdo do arquivo. |
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
|
insertOnly
|
insertOnly | boolean |
Se as chamadas hould falharão se já houver um arquivo existente com o mesmo nome |
|
|
nome
|
name | True | string |
Nome do arquivo |
Retornos
- Corpo
- ResponseOfFileResponse
Criar lista estática
Cria uma nova Lista Estática. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
Criar pasta
Cria uma nova pasta. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
- Corpo
- ResponseOfFolderResponse
Criar Programa
Cria um novo programa. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
canal
|
channel | True | string |
Canal do programa |
|
custar
|
cost | True | integer |
Valor do custo |
|
nota
|
note | string |
Anotações 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 |
|
tagType
|
tagType | string |
Tipo de marca de programa |
|
|
tagValue
|
tagValue | string |
Valor da marca |
|
|
tipo
|
type | True | string |
Tipo do programa |
Retornos
Criar trabalho de cliente potencial de exportação
Crie um trabalho de exportação para critérios de pesquisa definidos por meio do parâmetro "filter". A solicitação retorna a "exportId" que é passada como um parâmetro em chamadas subsequentes para pontos de extremidade potenciais de exportação em massa. Use o ponto de extremidade do Enqueue Export Lead Job para enfileirar o trabalho de exportação para processamento. Use o ponto de extremidade Obter Status do Trabalho Potencial de Exportação para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | True | string |
Nome da API REST para o campo de cabeçalho |
|
value
|
value | True | string |
Valor do campo de cabeçalho |
|
fields
|
fields | True | array of string |
Lista separada por vírgulas de campos a serem incluídos no arquivo |
|
endAt
|
endAt | string |
Filtro 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 clientes potenciais de |
|
smartListName
|
smartListName | True | string |
Nome da lista inteligente para recuperar clientes potenciais de |
|
staticListId
|
staticListId | True | integer |
ID da lista estática para recuperar clientes potenciais de |
|
staticListName
|
staticListName | True | string |
Nome da lista estática para recuperar clientes potenciais de |
|
format
|
format | string |
Formato de arquivo para criar("CSV", "TSV", "SSV"). O padrão é "CSV" |
Retornos
- Corpo
- ResponseOfExportResponse
Criar trabalho de membro do programa de exportação
Crie um trabalho de exportação para critérios de pesquisa definidos por meio do parâmetro "filter". A solicitação retorna a "exportId" que é passada como um parâmetro em chamadas subsequentes para pontos de extremidade membros do programa de exportação em massa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | True | string |
Nome da API REST para o campo de cabeçalho |
|
value
|
value | True | string |
Valor do campo de cabeçalho |
|
fields
|
fields | True | array of string |
Lista separada por vírgulas de campos a serem incluídos no arquivo |
|
programId
|
programId | True | integer |
ID do programa do qual recuperar membros. Não pode ser usado em combinação com o filtro "programIds" |
|
programIds
|
programIds | True | array of integer |
Matriz de IDs do programa da qual recuperar membros. Não pode ser usado em combinação com o filtro "programId" |
|
isExhausted
|
isExhausted | boolean |
Filtrar registros de associação ao programa para pessoas que esgotaram o conteúdo |
|
|
nurtureCadence
|
nurtureCadence | string |
Filtrar registros de associação ao programa para uma determinada cadência de nutrição |
|
|
statusNames
|
statusNames | array of string |
Matriz de nomes de status de membro 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 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 arquivo para criar("CSV", "TSV", "SSV"). O padrão é "CSV" |
Retornos
- Corpo
- ResponseOfExportResponse
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
Observação: este ponto de extremidade foi substituído. Em vez disso, use Descrever o ponto de extremidade do membro do programa .
Retornos
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
Retornos
Descrever o lead
Retorna metadados sobre objetos potenciais 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
Observação: este ponto de extremidade foi substituído. Em vez disso, use Descrever ponto de extremidade Descreva o Lead2 .
Retornos
- Corpo
- ResponseOfLeadAttribute
Descrever o Lead2
Retorna a lista de campos pesquisáveis em objetos potenciais na instância de destino. Permissões necessárias: Read-Only Lead, Read-Write Lead
Retornos
- Corpo
- ResponseOfLeadAttribute2
Enqueue Export Lead Job
Trabalho de exportação de enfileiramento. 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 Obter Status do Trabalho Potencial de Exportação para recuperar o status do trabalho de exportação. Permissões necessárias: Read-Only Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho em lote de exportação.
|
exportId | True | string |
ID do trabalho em lote de exportação. |
Retornos
- Corpo
- ResponseOfExportResponse
Excluir Clientes Potenciais
Exclua uma lista de clientes potenciais da instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
ID de inteiro exclusivo de um registro de lead |
|
O parâmetro poderá ser especificado se o corpo da solicitação estiver vazio.
|
id | array |
O parâmetro poderá ser especificado se o corpo da solicitação estiver vazio. Várias IDs potenciais podem ser especificadas. por exemplo, id=1,2,3,2342 |
Retornos
- Corpo
- ResponseOfLead
Excluir Lista Estática
Exclui a lista estática designada. Permissões necessárias: ativo Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista estática a ser excluída
|
id | True | integer |
ID da lista estática a ser excluída |
Retornos
- Corpo
- ResponseOfIdResponse
Excluir Lista Inteligente
Exclui a Lista Inteligente designada. Permissões necessárias: ativo Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista inteligente a ser excluída
|
id | True | integer |
ID da lista inteligente a ser excluída |
Retornos
- Corpo
- ResponseOfIdResponse
Excluir Marca de Programa
Excluir marca de programa não necessária. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
|
Tipo de marca de programa
|
tagType | True | string |
Tipo de marca de programa |
Retornos
- Corpo
- ResponseOfIdResponse
Excluir membros do programa
Exclua uma lista de membros da instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do programa de destino.
|
programId | True | integer |
A ID do programa de destino. |
|
leadId
|
leadId | True | integer |
ID de inteiro exclusivo de um registro de lead |
Retornos
Excluir Pasta
Exclui a pasta designada. A exclusão falhará se a pasta tiver conteúdo. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
- Corpo
- ResponseOfIdResponse
Excluir Programa
Exclui o programa de destino. O programa pode não conter nenhum ativo que esteja em uso fora do programa. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
Retornos
- Corpo
- ResponseOfIdResponse
Identidade
Recupere um token de acesso do Marketo. As chamadas para esse ponto de extremidade não são contadas para o limite de chamadas à API.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A CLIENTID para a API REST do Marketo
|
client_id | True | string |
ID do cliente no menu do Admin > Integration > Launchpoint. |
|
O segredo do cliente para a API REST do Marketo
|
client_secret | True | string |
Segredo do Cliente no menu Do Ponto de Inicialização do Admin > Integration > . |
|
O tipo de concessão. Nossas credenciais de cliente de caso
|
grant_type | True | string |
Tipo de concessão. |
Retornos
- Corpo
- ResponseOfIdentity
Identidade
Recupere um token de acesso do Marketo. As chamadas para esse ponto de extremidade não são contadas para o limite de chamadas à API.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A CLIENTID para a API REST do Marketo
|
client_id | True | string |
ID do cliente no menu do Admin > Integration > Launchpoint. |
|
O segredo do cliente para a API REST do Marketo
|
client_secret | True | string |
Segredo do Cliente no menu Do Ponto de Inicialização do Admin > Integration > . |
|
O tipo de concessão. Nossas credenciais de cliente de caso
|
grant_type | True | string |
Tipo de concessão. |
Retornos
- Corpo
- ResponseOfIdentity
Importar clientes potenciais
Importa um arquivo que contém registros de dados para a instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Importar formato de arquivo.
|
format | True | string |
Importar formato de arquivo. |
|
Campo a ser usado para eliminação de duplicação. Campos personalizados (cadeia de caracteres, email, inteiro)
|
lookupField | string |
Campo a ser usado para eliminação de duplicação. Há suporte para campos personalizados (cadeia de caracteres, email, inteiro) e os seguintes tipos de campo: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. O padrão é email. |
|
|
Nome da partição de lead para a qual importar.
|
partitionName | string |
Nome da partição de lead 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 que contém os registros de dados a serem importados.
|
file | True | file |
Arquivo que contém os registros de dados a serem importados. |
Retornos
Importar membros do programa
Importa um arquivo que contém registros de dados para a instância de destino. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa ao qual adicionar membros.
|
programId | True | string |
ID do programa ao qual adicionar membros. |
|
Status do membro do programa para membros que estão sendo adicionados.
|
programMemberStatus | True | string |
Status do membro do programa para membros que estão sendo adicionados. |
|
Importar formato de arquivo.
|
format | True | string |
Importar formato de arquivo. |
|
Arquivo que contém os registros de dados a serem importados.
|
file | True | file |
Arquivo que contém os registros de dados a serem importados. |
Retornos
Membro da lista
Verifica se os clientes potenciais são membros de uma determinada lista estática. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista estática com a qual verificar
|
listId | True | integer |
ID da lista estática com a qual verificar |
|
id
|
id | True | integer |
ID de inteiro exclusivo de um registro de lead |
|
Lista separada por vírgulas de IDs potenciais para verificar
|
id | array |
Lista separada por vírgulas de IDs potenciais para verificar |
Retornos
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 Obter Status do Trabalho de Membro do Programa de Exportação 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 membro do Programa de Exportação. Veja a seguir um exemplo do formato de arquivo padrão ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho em lote de exportação.
|
exportId | True | string |
ID do trabalho em lote de exportação. |
|
Para dar suporte à recuperação parcial de dados extraídos.
|
Range | string |
Para dar suporte à recuperação parcial de dados extraídos, o cabeçalho HTTP "Intervalo" do tipo "bytes" pode ser especificado. Consulte RFC 2616 "Solicitações de Recuperação de Intervalo" para obter mais informações. Se o cabeçalho não estiver definido, todo o conteúdo será retornado. |
Retornos
- 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do arquivo
|
id | True | integer |
ID do arquivo no banco de dados |
Retornos
- Corpo
- ResponseOfFileResponse
Obter arquivo por nome
Retorna registros de arquivos para o nome fornecido. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O nome do arquivo
|
name | True | string |
Nome do arquivo |
Retornos
- Corpo
- ResponseOfFileResponse
Obter arquivos
Retorna os arquivos da pasta fornecida. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
ID da pasta |
|
tipo
|
type | True | string |
Tipo de pasta |
|
maxReturn
|
maxReturn | integer |
Número máximo de canais a serem retornados. Máximo de 200, padrão 20 |
|
|
deslocamento
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
A pasta onde colocar o arquivo
|
folder | string |
Representação JSON da pasta pai, com os membros 'id' e 'type' que podem ser 'Folder' ou 'Program' |
Retornos
- Corpo
- ResponseOfFileResponse
Obter avisos de importação de clientes potenciais
Retorna a lista de avisos para o trabalho de importação em lote. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho de importação em lotes.
|
batchId | True | integer |
ID do trabalho de importação em lotes. |
Retornos
- response
- object
Obter avisos de membro do programa de importação
Retorna a lista de avisos para o trabalho de importação em lote. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho de importação em lotes.
|
batchId | True | integer |
ID do trabalho de importação em lotes. |
Retornos
- response
- object
Obter campanha por ID
Retorna o registro de uma campanha por sua ID. Permissões necessárias: campanhas de Read-Only, campanhas de Read-Write
Observação: este ponto de extremidade foi substituído. Em vez disso , use Obter Campanha Inteligente por ponto de extremidade de ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
campaignId
|
campaignId | True | integer |
campaignId |
Retornos
- Corpo
- ResponseOfCampaign
Obter campanhas
Retorna uma lista de registros de campanha. Permissões necessárias: campanhas Read-Only, campanhas de Read-Write
Observação: este ponto de extremidade foi substituído. Em vez disso, use o ponto de extremidade Obter Campanhas Inteligentes .
Parâmetros
| Nome | Chave | Obrigató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 separada por vírgulas de nomes para filtrar
|
name | array |
Lista separada por vírgulas de nomes 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á apenas as campanhas que são filhos dos programas designados. |
|
|
Lista separada por vírgulas de nomes de workspace para filtrar.
|
workspaceName | array |
Lista separada por vírgulas de nomes de workspace para filtrar. Se definido, retornará apenas campanhas nos workspaces fornecidos. |
|
|
Número máximo de registros a serem retornados. O máximo e o padrão são 300.
|
batchSize | integer |
Número máximo de registros a serem retornados. O máximo e o padrão sã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 esse ponto de extremidade se o conjunto de resultados for maior 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 for o gatilho solicitado e a origem for a API do Serviço Web
|
isTriggerable | boolean |
Definido como true para retornar campanhas ativas que têm uma campanha é o gatilho solicitado e a origem é a API do Serviço Web |
Retornos
- Corpo
- ResponseOfCampaign
Obter campo de cliente potencial por nome
Recupera metadados para um único campo de chumbo. Permissões necessárias: Read-Write campo padrão de esquema, Read-Write campo personalizado de esquema
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O nome da API do campo de potencial
|
fieldApiName | True | string |
O nome da API do campo de potencial |
Retornos
- Corpo
- 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 de esquema, Read-Write campo personalizado de esquema
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O nome da API do campo membro do programa
|
fieldApiName | True | string |
O nome da API do campo membro do programa |
Retornos
- Corpo
- ResponseOfLeadField
Obter clientes potenciais por ID de lista
Recupera registros de pessoa que são membros da lista estática fornecida. Permissões necessárias: Read-Only Lead, Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista estática da qual recuperar registros
|
listId | True | integer |
ID da lista estática da qual recuperar registros |
|
Lista separada por vírgulas de campos potenciais a serem retornados para cada registro.
|
fields | array |
Lista separada por vírgulas de campos potenciais a serem retornados para cada registro. Se unset retornar email, 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 esse ponto de extremidade se o conjunto de resultados for maior 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. |
Retornos
- Corpo
- ResponseOfLead
Obter clientes potenciais por ID de lista
Recupera registros de pessoa que são membros da lista estática fornecida. Permissões necessárias: Read-Only Lead, Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista estática da qual recuperar registros
|
listId | True | integer |
ID da lista estática da qual recuperar registros |
|
Lista separada por vírgulas de campos potenciais a serem retornados para cada registro.
|
fields | array |
Lista separada por vírgulas de campos potenciais a serem retornados para cada registro. Se unset retornar email, 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 esse ponto de extremidade se o conjunto de resultados for maior 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. |
Retornos
- Corpo
- ResponseOfLeadByListId
Obter clientes potenciais por ID do programa
Recupera uma lista de clientes potenciais que são membros do programa designado. Permissões necessárias: Read-Only Lead, Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do programa a ser recuperado de
|
programId | True | integer |
A ID do programa a ser recuperado 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 esse ponto de extremidade se o conjunto de resultados for maior 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. |
Retornos
- Corpo
- ResponseOfLead
Obter clientes potenciais por tipo de filtro
Retorna uma lista de até 300 clientes potenciais com base em uma lista de valores em um campo específico. Permissões necessárias: Read-Only Lead, Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O campo de chumbo no qual filtrar.
|
filterType | True | string |
O campo de chumbo no qual filtrar. Qualquer campo personalizado (somente tipos de cadeia de caracteres, email ou inteiros) e qualquer um dos seguintes campos tem suporte: 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 potenciais a serem retornados para cada registro
|
fields | array |
Uma lista separada por vírgulas de campos potenciais 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 esse ponto de extremidade se o conjunto de resultados for maior 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. |
Retornos
- Corpo
- ResponseOfLead
Obter conteúdo da pasta
Retorna registros para o conteúdo de uma determinada pasta. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigató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 serem retornados. Máximo de 200, padrão 20
|
maxReturn | integer |
Número máximo de canais a serem retornados. Máximo de 200, padrão 20 |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
Tipo de pasta. 'Folder' ou 'Program'. O padrão é 'Folder'
|
type | True | string |
Tipo de pasta. 'Folder' ou 'Program'. O padrão é 'Folder' |
Retornos
Obter falhas de cliente potencial de importação
Retorna a lista de falhas para o trabalho de importação em lote. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho de importação em lotes.
|
batchId | True | integer |
ID do trabalho de importação em lotes. |
Retornos
- response
- object
Obter falhas de membro do programa de importação
Retorna a lista de falhas para o trabalho de importação em lote. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho de importação em lotes.
|
batchId | True | integer |
ID do trabalho de importação em lotes. |
Retornos
- response
- object
Obter Lista Estática por ID
Recupera um registro de lista estática por sua ID. Permissões necessárias: Read-Asset ou ativo Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista estática a ser recuperada
|
id | True | integer |
ID da lista estática a ser recuperada |
Retornos
Obter lista estática por nome
Recupera um registro de Lista Estática por seu nome. Permissões necessárias: ativo Read-Asset ou Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da lista estática a ser recuperada
|
name | True | string |
Nome da lista estática a ser recuperada |
Retornos
Obter Lista Inteligente por ID
Recupera um registro de Lista Inteligente por sua ID. Permissões necessárias: Read-Asset ou ativo Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista inteligente a ser recuperada
|
id | True | integer |
ID da lista inteligente a ser recuperada |
|
Defina true para preencher regras de lista inteligente. Falso padrão
|
includeRules | boolean |
Defina true para preencher regras de lista inteligente. Falso padrão |
Retornos
Obter Lista Inteligente por ID do Programa
Recupera um registro de Lista Inteligente por sua ID do Programa de Email. Permissões necessárias: Read-Asset ou ativo Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa de email que contém a lista inteligente a ser recuperada
|
programId | True | integer |
ID do programa de email que contém a lista inteligente a ser recuperada |
|
Defina true para preencher regras de lista inteligente. Falso padrão
|
includeRules | boolean |
Defina true para preencher regras de lista inteligente. Falso padrão |
Retornos
Obter Lista Inteligente por Nome
Recupera um registro de Lista Inteligente pelo nome. Permissões necessárias: ativo Read-Asset ou Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da lista inteligente a ser recuperada
|
name | True | string |
Nome da lista inteligente a ser recuperada |
Retornos
Obter Lista por ID
Retorna um registro de lista por sua ID. Permissões necessárias: Read-Only Lead, Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista estática da qual recuperar registros
|
listId | True | integer |
ID da lista estática da qual recuperar registros |
Retornos
- Corpo
- ResponseOfStaticList
Obter listas
Retorna um conjunto de registros de lista estáticos com base em determinados parâmetros de filtro. Permissões necessárias: Read-Only Lead, Read-Write Lead
Parâmetros
| Nome | Chave | Obrigató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 lista estática a serem retornados
|
name | array |
Lista separada por vírgulas de nomes de lista estática 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 determinados |
|
|
Lista separada por vírgulas de nomes de workspace.
|
workspaceName | array |
Lista separada por vírgulas de nomes de workspace. Se definido retornará todas as listas estáticas que são filhos dos workspaces 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 esse ponto de extremidade se o conjunto de resultados for maior 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. |
Retornos
- Corpo
- ResponseOfStaticList
Obter listas estáticas
Recupera uma lista de registros de lista estática. Permissões necessárias: ativo Read-Asset ou Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Representação JSON da pasta pai
|
folder | string |
Representação JSON da pasta pai, com os membros 'id' e 'type' que podem ser 'Folder' ou 'Program' |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
Número máximo de listas estáticas a serem retornadas. Máximo de 200, padrão 20.
|
maxReturn | integer |
Número máximo de listas estáticas a serem retornadas. Máximo de 200, padrão 20. |
|
|
Exclua listas estáticas antes dessa data. Consulte a descrição do tipo de campo Datetime.
|
earliestUpdatedAt | string |
Exclua listas estáticas antes dessa data. Deve ser uma cadeia de caracteres ISO-8601 válida. Consulte a descrição do tipo de campo Datetime . |
|
|
Exclua listas estáticas após esta data. Consulte a descrição do tipo de campo Datetime.
|
latestUpdatedAt | string |
Exclua listas estáticas após esta data. Deve ser uma cadeia de caracteres ISO-8601 válida. Consulte a descrição do tipo de campo Datetime . |
Retornos
Obter listas inteligentes
Recupera uma lista de registros de Lista Inteligente criados pelo usuário. Permissões necessárias: ativo Read-Asset ou Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Representação JSON da pasta pai
|
folder | string |
Representação JSON da pasta pai, com os membros 'id' e 'type' que podem ser 'Folder' ou 'Program' |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
|
|
Número máximo de listas inteligentes a serem retornadas. Máximo de 200, padrão 20.
|
maxReturn | integer |
Número máximo de listas inteligentes a serem retornadas. Máximo de 200, padrão 20. |
|
|
Exclua listas inteligentes antes desta data. Consulte a descrição do tipo de campo Datetime.
|
earliestUpdatedAt | string |
Exclua listas inteligentes antes desta data. Deve ser uma cadeia de caracteres ISO-8601 válida. Consulte a descrição do tipo de campo Datetime . |
|
|
Exclua listas inteligentes após esta data. Consulte a descrição do tipo de campo Datetime.
|
latestUpdatedAt | string |
Exclua listas inteligentes após esta data. Deve ser uma cadeia de caracteres ISO-8601 válida. Consulte a descrição do tipo de campo Datetime . |
Retornos
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 membro do programa poderá ser processado pela solicitação. Permissões necessárias: Read-Only Lead, Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do programa de destino.
|
programId | True | integer |
A ID do programa de destino. |
|
O campo membro do programa a ser filtrado.
|
filterType | True | string |
O campo membro do programa no qual 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 por meio 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 intervalo de datas de início
|
startAt | string |
Ao usar filterType=updatedAt, o filtro de intervalo de datas (formato ISO 8601) |
|
|
Ao usar filterType=updatedAt, o filtro de intervalo de datas final
|
endAt | string |
Ao usar filterType=updatedAt, o filtro de intervalo de datas (formato ISO 8601) |
|
|
Uma lista separada por vírgulas de campos potenciais a serem retornados para cada registro.
|
fields | array |
Uma lista separada por vírgulas de campos potenciais 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 esse ponto de extremidade se o conjunto de resultados for maior 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. |
Retornos
- Corpo
- ResponseOfProgramMember
Obter o arquivo de cliente potencial 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 Obter Status do Trabalho Potencial de Exportação 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 Potencial de Exportação. Veja a seguir um exemplo do formato de arquivo padrão ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho em lote de exportação.
|
exportId | True | string |
ID do trabalho em lote de exportação. |
|
Para dar suporte à recuperação parcial de dados extraídos
|
Range | string |
Para dar suporte à recuperação parcial de dados extraídos, o cabeçalho HTTP "Intervalo" do tipo "bytes" pode ser especificado. Consulte RFC 2616 "Solicitações de Recuperação de Intervalo" para obter mais informações. Se o cabeçalho não estiver definido, todo o conteúdo será retornado. |
Retornos
- response
- object
Obter o cliente potencial 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do marketo lead
|
leadId | True | integer |
A ID do marketo lead |
|
Lista separada por vírgulas de nomes de campo.
|
fields | array |
Lista separada por vírgulas de nomes de campo. Se omitido, os seguintes campos padrão serão retornados: email, updatedAt, createdAt, lastName, firstName e id. |
Retornos
- Corpo
- ResponseOfLead
Obter o status do cliente potencial de importação
Retorna o status de um trabalho em lotes de importação. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho de importação em lotes.
|
batchId | True | integer |
ID do trabalho de importação em lotes. |
Retornos
Obter o status do trabalho de cliente potencial de exportação
Retorna o status de um trabalho de exportação. O status do trabalho está disponível por 30 dias depois que o status concluído ou com falha foi atingido. Permissões necessárias: Read-Only Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho em lote de exportação.
|
exportId | True | string |
ID do trabalho em lote de exportação. |
Retornos
- Corpo
- ResponseOfExportResponse
Obter o status do trabalho de membro do programa de exportação
Retorna o status de um trabalho de exportação. O status do trabalho está disponível por 30 dias depois que o status concluído ou com falha foi atingido. Permissões necessárias: Read-Only Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho em lote de exportação.
|
exportId | True | string |
ID do trabalho em lote de exportação. |
Retornos
- Corpo
- ResponseOfExportResponse
Obter Pasta por ID
Retorna o registro de pasta com a ID fornecida. Permissões necessárias: Read-Only Ativos Read-Write Ativos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A 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. 'Folder' ou 'Program' |
Retornos
- Corpo
- ResponseOfFolderResponse
Obter Pasta por Nome
Retorna um registro de pasta para o nome fornecido. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigató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. 'Folder' ou 'Program' |
|
|
A referência da pasta pai
|
root | string |
Referência de pasta pai |
|
|
O nome do espaço de trabalho
|
workSpace | string |
Nome do workspace |
Retornos
- Corpo
- ResponseOfFolderResponse
Obter Pastas
Recupera pastas filho de dentro de uma determinada pasta raiz. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Referência de pasta pai
|
root | string |
Referência de 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 de 200
|
maxReturn | integer |
Número máximo de pastas a serem retornadas. Padrão 20, máximo de 200 |
|
|
Deslocamento inteiro para paginação. Padrão 0
|
offset | integer |
Deslocamento inteiro para paginação. Padrão 0 |
|
|
Nome do workspace
|
workSpace | string |
Nome do workspace |
Retornos
- Corpo
- ResponseOfFolderResponse
Obter Programa por ID
Recupera o registro do programa para a ID fornecida. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
Retornos
Obter Programa por Nome
Recupera o registro do programa para o nome fornecido. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do programa
|
name | True | string |
Nome do programa |
|
Definir true para preencher marcas de programa
|
includeTags | boolean |
Definir true para preencher marcas de programa |
|
|
Definir true para preencher os custos do programa
|
includeCosts | boolean |
Definir true para preencher os custos do programa |
Retornos
Obter programas
Recupera a lista de programas acessíveis da instância de destino. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número máximo de canais a serem retornados. Máximo de 200, padrão 20
|
maxReturn | integer |
Número máximo de canais a serem retornados. Máximo de 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 |
|
|
Exclua programas antes desta data. Consulte a descrição do tipo de campo Datetime.
|
earliestUpdatedAt | string |
Exclua programas antes desta data. Deve ser uma cadeia de caracteres ISO-8601 válida. Consulte a descrição do tipo de campo Datetime . |
|
|
Exclua programas após esta data. Consulte a descrição do tipo de campo Datetime.
|
latestUpdatedAt | string |
Exclua programas após esta data. Deve ser uma cadeia de caracteres ISO-8601 válida. Consulte a descrição do tipo de campo Datetime . |
Retornos
Obter programas por marca
Recupera uma lista de programas que correspondem ao tipo de marca e aos valores de marca fornecidos. Permissões necessárias: ativos Read-Only, ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de marca de programa
|
tagType | True | string |
Tipo de marca de programa |
|
Valor da marca
|
tagValue | True | string |
Valor da marca |
|
Número máximo de canais a serem retornados. Máximo de 200, padrão 20
|
maxReturn | integer |
Número máximo de canais a serem retornados. Máximo de 200, padrão 20 |
|
|
Deslocamento inteiro para paginação
|
offset | integer |
Deslocamento inteiro para paginação |
Retornos
Obter status de membro do programa de importação
Retorna o status de um trabalho em lotes de importação. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho de importação em lotes.
|
batchId | True | integer |
ID do trabalho de importação em lotes. |
Retornos
Obter trabalhos 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
| Nome | Chave | Obrigató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 esse ponto de extremidade se o conjunto de resultados for maior que o tamanho do lote.
|
nextPageToken | string |
Um token será retornado por esse ponto de extremidade se o conjunto de resultados for maior 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. |
Retornos
Obter trabalhos potenciais 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
| Nome | Chave | Obrigató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 esse ponto de extremidade se o conjunto de resultados for maior 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. |
Retornos
Programa Desaplicativo
Não aprova o programa de destino. Válido apenas para programas de email aprovados. Permissões necessárias: ativos Read-Write
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do programa
|
id | True | integer |
id |
Retornos
- Corpo
- ResponseOfIdResponse
Push Lead to Marketo
Upserts um lead e gera um Push Lead para a atividade Marketo. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | integer |
ID de inteiro exclusivo de um registro de lead |
|
|
codificar
|
code | True | string |
Código inteiro do motivo |
|
mensagem
|
message | True | string |
Mensagem que descreve o motivo do status da operação |
|
status
|
status | string |
Status da operação executada no registro |
|
|
lookupField
|
lookupField | string | ||
|
partitionName
|
partitionName | string | ||
|
programName
|
programName | string | ||
|
programStatus
|
programStatus | string | ||
|
reason
|
reason | string | ||
|
fonte
|
source | string |
Retornos
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista estática para remover clientes potenciais de
|
listId | True | integer |
ID da lista estática para remover clientes potenciais de |
|
id
|
id | True | integer |
ID de inteiro exclusivo de um registro de lead |
|
id
|
id | True | array |
id |
Retornos
Sincronizar dados de membro do programa
Altera os dados de membro do programa de uma lista de clientes potenciais em um programa de destino. Somente os membros existentes do programa podem ter seus dados alterados com essa API. Permissões necessárias: Read-Write Lead
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do programa de destino.
|
programId | True | integer |
A ID do programa de destino. |
|
leadId
|
leadId | True | integer |
ID de 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 Descreva o 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 Descreva o Membro do Programa . |
Retornos
Status do Membro do Programa de Sincronização
Altera o status do membro do programa de uma lista de clientes potenciais 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do programa de destino.
|
programId | True | integer |
A ID do programa de destino. |
|
statusName
|
statusName | True | string |
Status do membro do programa |
|
leadId
|
leadId | True | integer |
ID de inteiro exclusivo de um registro de lead |
Retornos
Trabalho de Membro do Programa de Exportação de Enfileiramento
Trabalho de exportação de enfileiramento. 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho em lotes.
|
exportId | True | string |
ID do trabalho em lote de exportação. |
Retornos
- Corpo
- ResponseOfExportResponse
Definições
ResponseOfIdentity
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
access_token
|
access_token | string |
O token que você passa com chamadas subsequentes para autenticar com a instância de destino |
|
escopo
|
scope | string |
O usuário proprietário somente de API do serviço personalizado que foi usado para autenticar |
|
expires_in
|
expires_in | integer |
Tempo de vida restante do token atual em segundos |
|
token_type
|
token_type | string |
O método de autenticação OAuth |
ResponseOfStaticList
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of StaticList |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
Cliente Potencial
Registro de cliente potencial. Sempre contém id, mas pode ter qualquer número de outros campos, dependendo dos campos disponíveis na instância de destino.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID de inteiro exclusivo de um registro de lead |
|
associação
|
membership | ProgramMembership | |
|
reason
|
reason | Reason | |
|
status
|
status | string |
Status da operação executada no registro |
LeadField
Registro do campo de potencial
| Nome | 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 |
|
Datatype
|
dataType | string |
Tipo de dados do campo |
|
length
|
length | integer |
Comprimento máximo do campo. Aplicável somente à área de texto, cadeia de caracteres e texto. |
|
isHidden
|
isHidden | boolean |
Se definido como true, o campo ficará oculto |
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Se definido como true, o campo será codificado como HTML no email |
|
isSensitive
|
isSensitive | boolean |
Se definido como true, o campo será marcado como sensível |
|
isCustom
|
isCustom | boolean |
Se definido como true, o campo será personalizado |
|
isApiCreated
|
isApiCreated | boolean |
Se definido como true, o campo foi criado usando a API REST |
LeadFieldStatus
Status da atualização do campo de potencial
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da API do campo |
|
status
|
status | string |
Status da operação executada no registro |
ListOperationOutputData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID de inteiro exclusivo de um registro de lead |
|
Razões
|
reasons | array of Reason |
Lista de motivos pelos quais uma operação não foi bem-sucedida. Os motivos estão presentes apenas em respostas à API e não devem ser enviados |
|
status
|
status | string |
Status da operação executada no registro |
LeadAttribute
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Datatype
|
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 de inteiro exclusivo do campo |
|
length
|
length | integer |
Comprimento máximo do campo. Aplicável somente à área de texto, cadeia de caracteres e texto. |
|
rest
|
rest | LeadMapAttribute | |
|
sabão
|
soap | LeadMapAttribute |
LeadAttribute2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
"Líder de API" |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
Lista de campos pesquisáveis |
|
fields
|
fields | array of LeadAttribute2Fields |
Descrição de campos pesquisáveis |
LeadAttribute2SearchableFields
Lista de campos pesquisáveis
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
string |
Campo pesquisável |
LeadAttribute2Fields
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da API REST do campo |
|
nome de exibição
|
displayName | string |
Nome de exibição do campo (nome amigável) |
|
Datatype
|
dataType | string |
Tipo de dados do campo |
|
length
|
length | integer |
Comprimento do campo |
|
updateable
|
updateable | boolean |
O campo é atualizável |
|
crmManaged
|
crmManaged | boolean |
É o campo gerenciado pelo CRM |
LeadAttribute2Fields2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da API REST do campo |
|
nome de exibição
|
displayName | string |
Nome de exibição do campo (nome amigável) |
|
Datatype
|
dataType | string |
Tipo de dados do campo |
|
length
|
length | integer |
Comprimento do campo |
|
updateable
|
updateable | boolean |
O campo é atualizável |
|
crmManaged
|
crmManaged | boolean |
É o campo gerenciado pelo CRM |
ProgramMemberAttribute
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
"Membro do programa de API" |
|
fields
|
fields | array of LeadAttribute2Fields |
Descrição de campos pesquisáveis |
ProgramMemberAttribute2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
"Membro do programa de API" |
|
descrição
|
description | string |
"Mapa do Membro do Programa de API" |
|
createdAt
|
createdAt | string |
Datetime quando criado |
|
updatedAt
|
updatedAt | string |
Datetime atualizado |
|
dedupeFields
|
dedupeFields | array of string |
Lista de campos de dedupe |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
Lista de campos pesquisáveis |
|
fields
|
fields | array of LeadAttribute2Fields2 |
Descrição de campos pesquisáveis |
ResponseOfImportLeadResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ImportLeadResponse |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ImportProgramMemberResponse
Resposta que contém informações de status de importação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
batchId
|
batchId | integer |
ID de inteiro exclusivo do trabalho de importação |
|
importId
|
importId | string |
ID de inteiro exclusivo do trabalho de importação |
|
status
|
status | string |
Status do trabalho de importação |
ResponseOfImportProgramMemberResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ImportProgramMemberResponse |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfCampaign
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of Campaign |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfListOperationOutputData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ListOperationOutputData |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
Campanha
Registro de uma campanha inteligente do Marketo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ativo
|
active | boolean |
Se a campanha está ativa. Aplicável somente a campanhas de gatilho |
|
createdAt
|
createdAt | string |
Datetime quando a campanha foi criada |
|
descrição
|
description | string |
Descrição da Campanha Inteligente |
|
id
|
id | integer |
ID de inteiro exclusiva da Campanha Inteligente |
|
nome
|
name | string |
Nome da campanha inteligente |
|
programId
|
programId | integer |
ID do programa pai, se aplicável |
|
programName
|
programName | string |
Nome do programa pai, se aplicável |
|
tipo
|
type | string |
Tipo da Campanha Inteligente |
|
updatedAt
|
updatedAt | string |
Datetime quando a campanha foi atualizada mais recentemente |
|
workspaceName
|
workspaceName | string |
Nome do workspace pai, se aplicável |
ResponseOfLead
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of Lead |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfLeadByListId
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of Lead |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfLeadField
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of LeadField |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfUpdateLeadField
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of LeadFieldStatus |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfPushLeadToMarketo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of Lead |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfLeadAttribute
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of LeadAttribute |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfLeadAttribute2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of LeadAttribute2 |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfProgramMemberAttributes
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ProgramMemberAttribute |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfProgramMemberAttributes2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ProgramMemberAttribute2 |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
Aviso
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | integer |
Código inteiro do aviso |
|
mensagem
|
message | string |
Mensagem que descreve o aviso |
ResponseOfExportResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ExportResponse |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfExportResponseWithToken
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ExportResponse |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfProgramMember
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ProgramMember |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ProgramMember
Registro de membro do programa. Sempre contém a ID do cliente potencial, mas pode ter qualquer número de outros campos, dependendo dos campos disponíveis na instância de destino.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Seq
|
seq | integer |
Inteiro que indica a sequência do registro em resposta. Esse valor está correlacionado à ordem dos registros incluídos na entrada da solicitação. Seq só deve fazer parte das respostas e não deve ser enviado. |
|
leadId
|
leadId | integer |
ID de inteiro exclusivo de um registro de lead |
|
reachedSuccess
|
reachedSuccess | boolean |
Booliano indicando se o membro do programa atingiu critérios de êxito para o programa |
|
programId
|
programId | integer |
ID de inteiro exclusivo de um programa |
|
acquiredBy
|
acquiredBy | boolean |
Booliano indicando se o membro do programa foi adquirido pelo programa |
|
membershipDate
|
membershipDate | string |
Data em que o líder se tornou um membro do programa |
ResponseOfProgramMemberStatus
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ProgramMemberStatusResponse |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfProgramMemberData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ProgramMemberStatusResponse |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ResponseOfProgramMemberDelete
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error |
Matriz de erros ocorridos se a solicitação não tiver sido bem-sucedida |
|
moreResult
|
moreResult | boolean |
Booliano indicando se há mais resultados em páginas subsequentes |
|
nextPageToken
|
nextPageToken | string |
Token de paginação fornecido se o conjunto de resultados excedeu o tamanho do lote permitido |
|
requestId
|
requestId | string |
ID da solicitação feita |
|
resultado
|
result | array of ProgramMemberDeleteResponse |
A matriz de resultados para registros individuais na operação pode estar vazia |
|
sucesso
|
success | boolean |
Se a solicitação foi bem-sucedida |
|
Avisos
|
warnings | array of Warning |
Matriz de avisos dados para a operação |
ImportLeadResponse
Resposta que contém informações de status de importação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
batchId
|
batchId | integer |
ID de inteiro exclusiva do lote de importação |
|
importId
|
importId | string | |
|
mensagem
|
message | string | |
|
numOfLeadsProcessed
|
numOfLeadsProcessed | integer |
Número de linhas processadas até agora |
|
numOfRowsFailed
|
numOfRowsFailed | integer |
O número de linhas falhou até agora |
|
numOfRowsWithWarning
|
numOfRowsWithWarning | integer |
Número de linhas com um aviso até agora |
|
status
|
status | string |
Status do lote |
ProgramMembership
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
acquiredBy
|
acquiredBy | boolean |
Se o cliente potencial foi adquirido pelo programa pai |
|
isExhausted
|
isExhausted | boolean |
Se o lead está esgotado no momento no fluxo, se aplicável |
|
membershipDate
|
membershipDate | string |
Data em que o líder se tornou um membro do programa |
|
nurtureCadence
|
nurtureCadence | string |
Cadência do fluxo pai, se aplicável |
|
progressStatus
|
progressionStatus | string |
Status do programa do cliente potencial no programa pai |
|
reachedSuccess
|
reachedSuccess | boolean |
Se o cliente potencial está em um status de sucesso no programa pai |
|
fluxo
|
stream | string |
Transmitir do qual o cliente potencial é membro, se o programa pai for um programa de engajamento |
ExportResponse
Resposta que contém informações de status do trabalho de exportação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
createdAt
|
createdAt | date-time |
Data em que a solicitação de exportação foi criada |
|
errorMsg
|
errorMsg | string |
Mensagem de erro em caso de status "Falha" |
|
exportId
|
exportId | string |
ID exclusiva do trabalho de exportação |
|
tamanho do arquivo
|
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 |
Hash SHA-256 de arquivo exportado. Isso terá um valor somente quando o status for "Concluído", caso contrário, nulo |
|
finishedAt
|
finishedAt | date-time |
Concluir a hora do trabalho de exportação. Isso terá valor somente quando o status for "Concluído" ou "Falha", caso contrário, nulo |
|
format
|
format | string |
Formato do arquivo conforme especificado na solicitação ("CSV", "TSV", "SSV") |
|
numberOfRecords
|
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 |
|
queuedAt
|
queuedAt | date-time |
Tempo de fila do trabalho de exportação. Isso terá valor quando o status "Enfileirado" for atingido, antes que seja nulo |
|
startedAt
|
startedAt | date-time |
Hora de início do trabalho de exportação. Isso terá valor quando o status "Processamento" for atingido, antes que seja nulo |
|
status
|
status | string |
Status do trabalho de exportação ("Criado", "Enfileirado", "Processamento","Cancelado","Concluído","Falha") |
Reason
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código inteiro do motivo |
|
mensagem
|
message | string |
Mensagem que descreve o motivo do status da operação |
LeadMapAttribute
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do atributo |
|
somente leitura
|
readOnly | boolean |
Se o atributo é somente leitura |
Erro
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código de erro do erro. Veja a lista completa de códigos de erro aqui |
|
mensagem
|
message | string |
Mensagem que descreve a causa do erro |
ProgramMemberStatusResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | string |
Status da operação executada no registro |
|
Razões
|
reasons | array of Reason |
Lista de motivos pelos quais uma operação não foi bem-sucedida. Os motivos estão presentes apenas em respostas à API e não devem ser enviados |
|
leadId
|
leadId | integer |
ID do cliente potencial associado ao membro do programa |
|
Seq
|
seq | integer |
Inteiro que indica a sequência do registro em resposta. Esse valor está correlacionado à ordem dos registros incluídos na entrada da solicitação. Seq só deve fazer parte das respostas e não deve ser enviado. |
ProgramMemberDeleteResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | string |
Status da operação executada no registro |
|
Razões
|
reasons | array of Reason |
Lista de motivos pelos quais uma operação não foi bem-sucedida. Os motivos estão presentes apenas em respostas à API e não devem ser enviados |
|
leadId
|
leadId | integer |
ID do cliente potencial associado ao membro do programa |
|
Seq
|
seq | integer |
Inteiro que indica a sequência do registro em resposta. Esse valor está correlacionado à ordem dos registros incluídos na entrada da solicitação. Seq só deve fazer parte das respostas e não deve ser enviado. |
StaticList
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
createdAt
|
createdAt | string |
Datetime quando a lista foi criada |
|
descrição
|
description | string |
Descrição da lista estática |
|
id
|
id | integer |
ID de inteiro exclusivo da lista estática |
|
nome
|
name | string |
Nome da lista estática |
|
programName
|
programName | string |
Nome do programa |
|
updatedAt
|
updatedAt | string |
Datetime quando a lista foi atualizada mais recentemente |
|
workspaceName
|
workspaceName | string |
Nome do workspace pai, se aplicável |
BrowseAllPrograms
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
canal
|
channel | string |
Canal do programa |
|
createdAt
|
createdAt | date-time |
Datetime, 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 do SFDC |
|
sfdcName
|
sfdcName | string |
Nome da campanha SFDC vinculada, se aplicável |
|
status
|
status | string |
Status do programa. Válido somente para tipos de programa de email e de participação. |
|
tipo
|
type | string |
Tipo do programa |
|
updatedAt
|
updatedAt | date-time |
Datetime o ativo foi atualizado mais recentemente |
|
url
|
url | string |
URL do ativo na interface do usuário do Marketo |
|
espaço de trabalho
|
workspace | string |
Nome do workspace |
FolderContentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
tipo
|
type | string |
FileFolder
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string | |
|
tipo
|
type | string |
ResponseOfProgramResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of ProgramResponse | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
ResponseOfSmartListResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of SmartListResponse | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
ResponseOfSmartListResponseWithRules
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of SmartListResponseWithRules | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
SmartListResponse
| Nome | 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 |
|
createdAt
|
createdAt | date-time |
Datetime, a lista inteligente foi criada |
|
updatedAt
|
updatedAt | date-time |
Datetime, 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 |
|
espaço de trabalho
|
workspace | string |
Nome do workspace |
SmartListResponseWithRules
| Nome | 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 |
|
createdAt
|
createdAt | date-time |
Datetime, a lista inteligente foi criada |
|
updatedAt
|
updatedAt | date-time |
Datetime, 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 |
|
espaço de trabalho
|
workspace | string |
Nome do workspace |
|
regras
|
rules | SmartListRules |
Representação JSON de regras de lista inteligente |
ResponseOfStaticListResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of StaticListResponse | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
StaticListResponse
| Nome | 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 |
|
createdAt
|
createdAt | date-time |
Datetime, a lista estática foi criada |
|
updatedAt
|
updatedAt | date-time |
Datetime, 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 |
|
espaço de trabalho
|
workspace | string |
Nome do workspace |
|
computedUrl
|
computedUrl | string |
ProgramResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
canal
|
channel | string |
Canal do programa |
|
costs
|
costs | array of Costs |
Listas de custos de período associados |
|
createdAt
|
createdAt | date-time |
Datetime, o ativo foi criado |
|
descrição
|
description | string |
Descrição do ativo |
|
data de término
|
endDate | date-time |
Data de término do programa. Aplicável a programas de tipo de evento, email 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 do SFDC |
|
sfdcName
|
sfdcName | string |
Nome da campanha SFDC vinculada, se aplicável |
|
startDate
|
startDate | date-time |
Data de início do programa. Aplicável a programas de tipo de evento, email e webinar |
|
status
|
status | string |
Status do programa. Válido somente para tipos de programa de email e de participação. |
|
tags
|
tags | array of Tags |
Lista de marcas de programa associadas |
|
tipo
|
type | string |
Tipo do programa |
|
updatedAt
|
updatedAt | date-time |
Datetime o ativo foi atualizado mais recentemente |
|
url
|
url | string |
URL do ativo na interface do usuário do Marketo |
|
espaço de trabalho
|
workspace | string |
Nome do workspace |
|
marketingProgramProgressionId
|
marketingProgramProgressionId | integer | |
|
headStart
|
headStart | boolean |
Se a função 'Head Start' está habilitada para o programa |
FileResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
createdAt
|
createdAt | date-time |
Datetime quando o arquivo foi criado |
|
descrição
|
description | string |
Descrição do arquivo |
|
pasta
|
folder | FileFolder | |
|
id
|
id | integer |
ID do arquivo |
|
Tipo MIME
|
mimeType | string |
Tipo MIME do arquivo |
|
nome
|
name | string |
Nome do arquivo |
|
size
|
size | integer |
Tamanho do arquivo em bytes |
|
updatedAt
|
updatedAt | date-time |
Datetime quando o arquivo foi atualizado mais recentemente |
|
url
|
url | string |
URL acessível publicamente do arquivo |
ResponseOfFileResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of FileResponse | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
FolderResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
accessZoneId
|
accessZoneId | integer | |
|
createdAt
|
createdAt | date-time |
Datetime, a pasta foi criada |
|
descrição
|
description | string |
Descrição da pasta |
|
folderId
|
folderId | Folder |
Representação JSON de uma pasta |
|
folderType
|
folderType | string |
Tipo de pasta |
|
id
|
id | integer |
ID da pasta |
|
isArchive
|
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 |
|
pai
|
parent | Folder |
Representação JSON de uma pasta |
|
caminho
|
path | string |
Caminho da pasta |
|
updatedAt
|
updatedAt | date-time |
Datetime, a pasta foi atualizada pela última vez |
|
url
|
url | string |
URL da pasta |
|
espaço de trabalho
|
workspace | string |
Nome do workspace |
ResponseOfIdResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of IdResponse | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
Etiquetas
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tagType
|
tagType | string |
Nome da marca |
|
tagValue
|
tagValue | string |
Valor da marca |
ResponseOfBrowseAllPrograms
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of BrowseAllPrograms | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
ResponseOfFolderResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of FolderResponse | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
ResponseOfFolderContentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
resultado
|
result | array of FolderContentResponse | |
|
sucesso
|
success | boolean | |
|
Avisos
|
warnings | array of string |
IdResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID do ativo |
Custos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
custar
|
cost | integer |
Valor do custo |
|
nota
|
note | string |
Anotações sobre o custo |
|
startDate
|
startDate | date-time |
Data de início do custo do período |
ProgramFolder
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string |
O tipo de pasta do programa |
|
value
|
value | integer |
A ID da pasta do programa |
|
folderName
|
folderName | string |
O nome da pasta do programa |
Pasta
Representação JSON de uma pasta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
ID da pasta |
|
tipo
|
type | string |
Tipo de pasta |
SmartListRules
Representação JSON de regras de lista inteligente
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
filterMatchType
|
filterMatchType | string |
Tipo de correspondência de filtro de lista inteligente (lógica de regra) |
|
gatilhos
|
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
| Nome | 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 de lista inteligente |
SmartListConditions
Representação JSON de condições de lista inteligente
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
activityAttributeId
|
activityAttributeId | integer |
ID do atributo de atividade |
|
activityAttributeName
|
activityAttributeName | string |
Nome do atributo de atividade |
|
operador
|
operator | string |
Valor do operador |
|
values
|
values | array of string |
Lista de valores |
|
é Primário
|
isPrimary | boolean |
Se a condição é primária ou não (primeira condição da lista inteligente) |
objeto
Esse é o tipo 'object'.