Entendendo o Esquema Open API do Lead Gen & CRM: Emails
Última atualização: 9 de outubro de 2024
Lead Gen & CRM possui uma organização de API distinta. Este artigo detalhará as partes da API do Lead Gen & CRM relacionadas a emails.
Conteúdo do Artigo
| Administradores | ✓ | |
| Gerentes de Empresa | ||
| Gerentes de Marketing | ||
| Gerentes de Vendas | ||
| Vendedores | ||
| Vendedores Jr. |
Emails HTML criados no Lead Gen & CRM.
|
|
Nome |
Tipo | Comprimento | É Obrigatório |
| id | int | 18 | Opcional | |
| html | text | Obrigatório | ||
| emailName | varchar | 255 | Obrigatório | |
| subject | varchar | 255 | Obrigatório | |
| fromName | varchar | 255 | Obrigatório | |
| fromEmail | varchar | 255 | Obrigatório | |
| replyTo | varchar | 255 | Opcional | |
| unsubCategory | int | 18 | Opcional | |
| contactManager | tinyint | 1 | Opcional | |
| repeatable | tinyint | 1 | Opcional | |
| fromLeadOwner | tinyint | 1 | Opcional |
EmailEvent
Contém informações sobre as ações de um lead com emails específicos enviados em um trabalho de email.
|
|
Nome |
Tipo | Comprimento | É Obrigatório |
| leadID | int | 18 | Opcional | |
| emailID | int | 18 | Opcional | |
| emailJobID | int | 18 | Opcional | |
| createDate | timestamp | 255 | Opcional | |
| emailAddress | varchar | 150 | Opcional |
EmailJob
Associa dados de um determinado jobID com emailIDs e recipientIDs.
|
|
Nome |
Tipo | Comprimento | É Obrigatório |
| id | int | 18 | Opcional | |
| emailID | int | 18 | Opcional | |
| isList | tinyint | 1 | Opcional | |
| isActive | tinyint | 1 | Opcional | |
| recipientID | int | 18 | Opcional | |
| sendCount | int | 18 | Opcional | |
| confirmedSend | tinyint | 1 | Opcional | |
| allowDuplicates | tinyint | 1 | Opcional | |
| createTimestamp | timestamp | 255 | Opcional |
EmailListing
Contém informações sobre um grupo de emails, incluindo o ID, conteúdo HTML, linha de assunto e imagem em miniatura.
|
|
Nome |
Tipo | Comprimento | É Obrigatório |
| id | int | 18 | Opcional | |
| createTimestamp | timestamp | 255 | Opcional | |
| title | varchar | 255 | Opcional | |
| subject | varchar | 255 | Opcional | |
| thumbnail | varchar | 255 | Opcional |
EmailSend
Contém dados sobre trabalhos de email específicos, como aberturas, cliques e métricas de cancelamento de inscrição.
|
|
Nome |
Tipo | Comprimento | É Obrigatório |
| id | int | 18 | Opcional | |
| emailID | int | 18 | Opcional | |
| workflowID | int | 18 | Opcional | |
| sendCount | int | 50 | Opcional | |
| statistics | hash | 255 | Opcional | |
| domains | hash | 255 | Opcional | |
| numUnsubscribeReasons | array | 50 | Opcional | |
| uniqueOpens | int | 50 | Opcional | |
| uniqueClicks | int | 50 | Opcional |
EmailSendEvent
Contém informações sobre ações que um lead tomou com um trabalho de email.
|
|
Nome |
Tipo | Comprimento | É Obrigatório |
| id | int | 18 | Opcional | |
| contactID | int | 18 | Opcional | |
| type | varchar | 50 | Opcional |
ScheduleSend
Um envio de email que está agendado para ser realizado no Lead Gen & CRM. Um listID ou listTagID deve ser especificado. O envio deve ser agendado para ser enviado imediatamente ou uma data/hora deve ser fornecida.
|
|
Nome |
Tipo | Comprimento | É Obrigatório |
| emailID | int | 18 | Obrigatório | |
| listID | int | 18 | Obrigatório | |
| listTagID | int | 18 | Obrigatório | |
| immediate | tinyint | 1 | Opcional | |
| date | date | 255 | Opcional | |
| hours | int | 18 | Opcional | |
| minutes | int | 18 | Opcional | |
| meridiem | varchar | 255 | Opcional | |
| sendDuplicate | tinyint | 1 | Opcional |
ScheduleSendQueue
Contém informações sobre trabalhos de email enviando na fila de Eventos Agendados.
|
|
Nome |
Tipo | Comprimento | É Obrigatório |
| id | int | 18 | Opcional | |
| active | tinyint | 1 | Opcional | |
| fromemail | tinyint | 1 | Opcional |