Entendendo os Métodos da API Aberta do Lead Gen & CRM: E-mail

Informações Adicionais da API

Este artigo fornece conteúdo específico sobre os métodos da API do Lead Gen & CRM. No entanto, dada a extensão e o escopo da API, as informações estão divididas e contidas em diferentes artigos. Cada artigo foca em uma função específica da API do Lead Gen & CRM. Informações adicionais sobre a API podem ser encontradas nos seguintes artigos:

Compreendendo a API Aberta do Lead Gen & CRM: Visão Geral Compreendendo a API Aberta do Lead Gen & CRM: Esquema

Compreendendo a API Aberta do Lead Gen & CRM: Métodos Compreendendo a API Aberta do Lead Gen & CRM: Código de Exemplo Compreendendo a API Aberta do Lead Gen & CRM: Códigos de Erro

CreateSendEmail

createSendMail			Envia um email para uma lista ou listas de uma tag específica.
Params	Nome		Tipo		É Obrigatório
	objetos		list<ScheduleSend>		Obrigatório
Dados de Retorno	Nome		Tipo
	ações		list<CreateResult>

createEmail

createEmail			Criar um email a partir de HTML.
Params	Nome		Tipo		É Obrigatório
	objetos		list<Email>		Obrigatório
Dados de Retorno	Nome		Tipo
	ações		list<CreateResult>

deleteEmail			Especifica um ID de email a ser excluído no Lead Gen & CRM.
Params	Nome		Tipo		É Obrigatório
	objetos		list<id>		Obrigatório
Dados de Retorno	Nome		Tipo
	ações		list<DeleteResult>

getEmail			Retorna os dados HTML do email solicitado.
Params	Nome		Tipo		É Obrigatório
	id		int		Obrigatório
Dados de Retorno	Nome		Tipo
	campos		Retorna apenas os dados HTML

getEmailListing			Retorna uma lista de informações de e-mail.
Params	Nome		Tipo		É Obrigatório
	onde		hash Obrigatório: nenhum Opcional: id		Opcional
	limite		int		Opcional
	offset		int		Opcional
Dados de Retorno	Nome		Tipo
	campos		list<emailListing>

updateEmail			Especifica uma lista de E-mails existentes a serem atualizados no Lead Gen & CRM. O ID de cada e-mail deve ser passado para cada registro que está sendo atualizado.
Params	Nome		Tipo		É Obrigatório
	objeto		list<Email>		Obrigatório
Dados de Retorno	Nome		Tipo
	ações		list<UpdateResult>

EmailJob

deleteScheduleSend			Exclui um trabalho de e-mail agendado para enviar para uma lista ou um lead.
Params	Name		Type		Is Required
	jobID		int		Required
Return Data	Name		Type
	deletes		list<DeleteResult>

getEmailEvents			Recupera estatísticas de e-mail por jobID. Opcionalmente, filtra por tipo de evento. Valores permitidos para eventType são cliques, aberturas, devoluções, envios e cancelamentos de inscrição.
Params	Name		Type		Is Required
	emailJobID		int		Required
	eventType		string		Required
Return Data	Name		Type
	events		list<EmailEvent>

getEmailSendEvents			Recupera os envios de e-mail para um determinado trabalho de e-mail.
Params	Name		Type		Is Required
	sendID		int		Required
	eventType		string [sends, opens, clicks, bounces, spam, unsubscribes]		Required
	limit		int		Required
	startingAfter		int [eventID]		Optional
Return Data	Name		Type
	events		list<EmailSendEvent>
	hasMore		boolean

getEmailSendStatus			Recupera um status que determina se um trabalho de e-mail foi enviado ou está na fila.
Params	Name		Type		Is Required
	sendID		int		Required
Return Data	Name		Type
	status		n/a

getScheduleSendStatus			Recupera o status de envio de um trabalho de e-mail agendado.
Params	Name		Type		Is Required
	jobID		int		Required
	limit		int		Optional
	offset		int		Optional
Return Data	Name		Type
	automationEventQueue		id, taskID, workflowID, timeProcessed, processed, workflowEventData, sendDuplicate, email {id, companyID, fromEmail, fromName, subject, title}, whoID, whoType, whatID, whatType, createTimestamp

getScheduleSends			Recupera trabalhos de e-mail agendados para enviar por lista, lead, e-mail ou trabalho.
Params	Name		Type		Is Required
	where		hash Required: none Optional: id, campaignName		Required
Return Data	Name		Type
	sends		list<ScheduleSendQueue>

getSendCount			Recupera contagens de envios de e-mail por intervalo de datas e companyID para contas de agência e cliente.
Params	Name		Type		Is Required
	fromDate		timestamp		Required
	toDate		timestamp		Required
	companyID		int		Optional
Return Data	Name		Type
	sendCounts		list<companyID, sendCount>

Unsubscribe Category

getUnsubscribeCategories			Obtém uma lista de categorias de cancelamento de inscrição.
Params	Name		Type		Is Required
	none				Optional
Return Data	Name		Type
	getAllUnsubscribeCategories		list<UnsubscribeCategory>

getemailjob

getEmailJobs			Obtém uma lista de trabalhos de e-mail ativos para a conta atual.
Params	Name		Type		Is Required
	limit		string		Optional
	offset		string		Optional
Return Data	Name		Type
	getAllgetEmailJobs		list<EmailJob>