Entendendo o Esquema da API Aberta do Lead Gen & CRM: Leads
Última atualização: 9 de outubro de 2024
O Lead Gen & CRM possui uma organização de API distinta. Este artigo detalhará as partes da API do Lead Gen & CRM relacionadas a leads.
Conteúdo do Artigo
| Administradores | ✓ | |
| Gerentes de Empresa | ||
| Gerentes de Marketing | ||
| Gerentes de Vendas | ||
| Vendedores | ||
| Vendedores Jr. |
Lead
Um lead é um potencial cliente que possivelmente está interessado em seu produto. À medida que um lead avança pelo seu pipeline, seu status muda de não qualificado para qualificado. Um lead pode ser convertido em um contato, oportunidade ou conta.
Se você deseja atualizar campos personalizados para um lead, especifique o systemName do campo personalizado como a chave em seu objeto lead. Para obter uma lista de nomes de sistema, primeiro recupere os membros da tabela Field.
|
|
Nome |
Tipo | Comprimento | É Necessário |
| id | bigint | 20 | Opcional | |
| accountID | bigint | 20 | Opcional | |
| ownerID | bigint | 20 | Opcional | |
| campaignID | bigint | 20 | Opcional | |
| leadStatus | picklist | Opcional | ||
| leadScore | smallint | 6 | Opcional | |
| leadScoreWeighted | smaillint | 6 | Opcional | |
| persona | string | 128 | Opcional | |
| active | tinyint | 1 | Opcional | |
| firstName | varchar | 50 | Opcional | |
| lastName | varchar | 50 | Opcional | |
| emailAddress | varchar | 150 | Necessário | |
| companyName | varchar | 100 | Opcional | |
| title | varchar | 255 | Opcional | |
| street | varchar | 255 | Opcional | |
| city | varchar | 255 | Opcional | |
| country | varchar | 255 | Opcional | |
| state | varchar | 50 | Opcional | |
| zipcode | varchar | 50 | Opcional | |
| website | varchar | 255 | Opcional | |
| phoneNumber | varchar | 255 | Opcional | |
| trackingID | varchar | 255 | Opcional | |
| officePhoneNumber | varchar | 255 | Opcional | |
| phoneNumberExtension | varchar | 255 | Opcional | |
| mobilePhoneNumber | varchar | 255 | Opcional | |
| faxNumber | varchar | 255 | Opcional | |
| description | text | Opcional | ||
| industry | varchar | 255 | Opcional | |
| isUnsubscribed | tinyint | 1 | Opcional | |
| updateTimestamp | timestamp | Opcional |
Evento
Contém informações relacionadas a eventos de usuários do Lead Gen & CRM, semelhantes à Vida do Lead.
|
|
Nome |
Tipo | Comprimento | É Necessário |
| id | int | 18 | Opcional | |
| leadID | int | 18 | Necessário | |
| eventName | varchar | 255 | Necessário | |
| whatID | int | 18 | Opcional | |
| whatType | varchar | 255 | Opcional | |
| eventData | text | 255 | Opcional | |
| eventSource | text | 255 | Opcional | |
| createTimeStamp | timestamp | 255 | Necessário |
Campo
Contém metadados para um campo do Lead Gen & CRM. Isso inclui tanto campos de lead quanto de oportunidade. O systemName é uma chave que pode ser especificada em qualquer POST para criar ou atualizar um objeto.
|
|
Nome |
Tipo | Comprimento | É Necessário |
| id | int | 18 | Opcional | |
| relationship | varchar | 255 | Necessário | |
| systemName | varchar | 255 | Opcional | |
| label | varchar | 255 | Necessário | |
| source | varchar | 255 | Opcional | |
| dataType | varchar | 255 | Necessário | |
| dataLength | int | 18 | Necessário | |
| isRequired | tinyint | 1 | Necessário | |
| isCustom | tinyint | 1 | Necessário | |
| isActive | tinyint | 1 | Necessário | |
| isAvailableInContactManager | tinyint | 1 | Necessário | |
| isEditableInContactManager | tinyint | 1 | Necessário | |
| isAvailableInForms | tinyint | 1 | Necessário |
Informações Adicionais da API
Este artigo detalha o conteúdo específico do esquema sobre a API do Lead Gen & CRM. No entanto, dado o tamanho 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 da API podem ser encontradas nos seguintes artigos: