Pipeliner CRM (versão prévia)
Pipeliner é um software CRM de vendas de última geração projetado para capacitar as equipes de vendas e aumentar as relações de clientes lucrativas. O conector fornece uma API para trabalhar com registros do Pipeliner.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – 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 Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Pipeliner CRM |
| URL | https://www.pipelinersales.com |
| support@pipelinersales.com |
| Metadados do conector | |
|---|---|
| Publicador | Pipelinersales Corporation |
| Site | https://www.pipelinersales.com |
| Política de privacidade | https://www.pipelinersales.com/privacy/ |
| Categorias | Vendas e CRM; Produtividade |
Pipeliner CRM
Pipeliner é um software CRM de vendas de última geração projetado para capacitar as equipes de vendas e aumentar as relações de clientes lucrativas. O conector fornece uma API para trabalhar com registros do Pipeliner.
Publicador: Pipelinersales, Inc.
Pré-requisitos
Credenciais básicas de autenticação de acesso para API.
Operações com suporte
Conta
- Obter uma conta
- Criar uma conta
- Atualizar uma conta
- Excluir uma conta
Contato
- Obter um contato
- Criar um contato
- Atualizar um contato
- Excluir um contato
Cliente Potencial
- Obter um cliente potencial
- Criar um cliente potencial
- Atualizar um cliente potencial
- Excluir um cliente potencial
Oportunidade
- Obter uma oportunidade
- Criar uma oportunidade
- Atualizar uma oportunidade
- Excluir uma oportunidade
Tarefa
- Obter uma tarefa
- Criar uma tarefa
- Atualizar uma tarefa
- Excluir uma tarefa
Obtendo credenciais
A API de CRM do Pipeliner está usando a autenticação Básica, que consiste em Nome de Usuário e Senha.
O usuário precisa fornecer a URL de Serviço e a ID de Espaço.
Problemas e limitações conhecidos
A API retorna um máximo de 100 registros por solicitação.
Instruções de implantação
N/A
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 |
|---|---|---|---|
| Nome de usuário | secureString | O nome de usuário para esta api | Verdade |
| Senha | secureString | A senha dessa api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar Conta |
Modifica contas ou contas com determinadas IDs. |
| Atualizar Contato |
Modifica contatos ou contatos com determinadas IDs. |
| Atualizar o Lead |
Modifica o lead ou os clientes potenciais com determinadas IDs. |
| Criar conta |
Cria uma nova conta. |
| Criar Contato |
Cria um novo contato. |
| Criar Lead |
Cria um novo lead. |
| Criar oportunidade |
Cria uma nova oportunidade. |
| Criar Tarefa |
Cria uma nova tarefa. |
| Excluir Conta |
Remove a conta com determinada ID. |
| Excluir Contato |
Remove o contato com a ID fornecida. |
| Excluir Lead |
Remove o cliente potencial com determinada ID. |
| Excluir Oportunidade |
Remove a oportunidade com a ID fornecida. |
| Excluir Tarefa |
Remove a tarefa com determinada ID. |
| Obter conta |
Retorna a conta com a ID fornecida. |
| Obter contato |
Retorna contato com a ID fornecida. |
| Obter o cliente potencial |
Retorna o cliente potencial com determinada ID. |
| Obter oportunidade |
Retorna a oportunidade com a ID fornecida. |
| Obter Tarefa |
Obtenha a tarefa com a ID fornecida. |
| Oportunidade de Atualização |
Modifica oportunidades ou oportunidades com determinadas IDs. |
| Tarefa Atualizar |
Modifica tarefas ou tarefas com determinadas IDs. |
Atualizar Conta
Modifica contas ou contas com determinadas IDs.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
AccountID
|
id | True | string |
ID |
|
Nome da Conta
|
name | string | ||
|
ID do Proprietário
|
owner_id | string |
ID |
|
|
ID do tipo de conta
|
account_type_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | string |
ID |
|
|
Classe Account
|
account_class | integer |
1 – Sem Classe, 2 – Classe A, 3 – Classe B, 4 – Classe C, 5 – Classe D |
|
|
Email primário
|
email1 | string |
Endereço de email |
|
|
Telefone Primário
|
phone1 | string |
Número de telefone |
|
|
Home page
|
home_page | string |
URL |
|
|
Endereço
|
address | string | ||
|
City
|
city | string | ||
|
País
|
country | string | ||
|
Estado/Província
|
state_province | string | ||
|
Código Postal
|
zip_code | string | ||
|
Comments
|
comments | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
AccountID
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Tipo de conta
|
data.account_type | string | |
|
Tipo de cliente
|
data.customer_type | string | |
|
Setor
|
data.industry | string | |
|
Proprietário
|
data.owner | string | |
|
Conta pai
|
data.parent_account | string | |
|
Tipo de relação de conta pai
|
data.parent_account_relation_type | string | |
|
Picture
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Classe Account
|
data.account_class | integer | |
|
ID do tipo de conta
|
data.account_type_id | string | |
|
Endereço
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
País
|
data.country | string | |
|
ID do Tipo de Cliente
|
data.customer_type_id | string | |
|
Email primário
|
data.email1 | string | |
|
Email 2
|
data.email2 | string | |
|
Email 3
|
data.email3 | string | |
|
Email 4
|
data.email4 | string | |
|
Email 5
|
data.email5 | string | |
|
Categoria de integridade
|
data.health_category | string | |
|
Estado de saúde
|
data.health_status | integer | |
|
Página inicial
|
data.home_page | string | |
|
ID do setor
|
data.industry_id | string | |
|
Nome da Conta
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da conta pai
|
data.parent_account_id | string | |
|
ID do tipo de relação da conta pai
|
data.parent_account_relation_type_id | string | |
|
Telefone Primário
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID da imagem
|
data.picture_id | string | |
|
Nome da conta pai rápida
|
data.quick_parent_account_name | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Estado/Província
|
data.state_province | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Código Postal
|
data.zip_code | string | |
|
Revisão
|
data.revision | integer | |
|
Nome formatado
|
data.formatted_name | string | |
|
Mídias Sociais
|
data.social_media | string | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Não assinado
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Atualizar Contato
Modifica contatos ou contatos com determinadas IDs.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID de contato
|
id | True | string |
ID |
|
Título/Saudação
|
title | string | ||
|
Primeiro Nome
|
first_name | string | ||
|
Nome do Meio
|
middle_name | string | ||
|
Apelido
|
last_name | string | ||
|
Gênero
|
gender | integer |
0 - Desconhecido, 1 - Masculino, 2 - Feminino, 3 - Não binário |
|
|
ID do tipo de contato
|
contact_type_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | string |
ID |
|
|
ID do Proprietário
|
owner_id | string |
ID |
|
|
Email
|
email1 | string |
Endereço de email |
|
|
Telefone
|
phone1 | string |
Número de telefone |
|
|
Endereço
|
address | string | ||
|
City
|
city | string | ||
|
Estado/Província
|
state_province | string | ||
|
Código Postal
|
zip_code | string | ||
|
País
|
country | string | ||
|
Comments
|
comments | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID de contato
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data modificada
|
data.modified | string | |
|
Credo de Data
|
data.created | string | |
|
Tipo de contato
|
data.contact_type | string | |
|
Proprietário
|
data.owner | string | |
|
Picture
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Endereço
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
ID do tipo de contato
|
data.contact_type_id | string | |
|
País
|
data.country | string | |
|
Email primário
|
data.email1 | string | |
|
Email 2
|
data.email2 | string | |
|
Email 3
|
data.email3 | string | |
|
Email 4
|
data.email4 | string | |
|
Email 5
|
data.email5 | string | |
|
Primeiro Nome
|
data.first_name | string | |
|
Apelido
|
data.last_name | string | |
|
Nome do Meio
|
data.middle_name | string | |
|
Gênero
|
data.gender | integer |
0 - Desconhecido, 1 - Masculino, 2 - Feminino, 3 - Não binário |
|
ID do Proprietário
|
data.owner_id | string | |
|
Telefone Primário
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID da imagem
|
data.picture_id | string | |
|
Cargo
|
data.position | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Estado/Província
|
data.state_province | string | |
|
Title
|
data.title | string | |
|
ID da unidade
|
data.unit_id | string | |
|
Código Postal
|
data.zip_code | string | |
|
Revisão
|
data.revision | integer | |
|
Nome formatado
|
data.formatted_name | string | |
|
Mídias Sociais
|
data.social_media | string | |
|
Conta primária
|
data.primary_account | string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Funções de conta primária
|
data.primary_account_account_roles | array of string | |
|
Posição da conta primária
|
data.primary_account_position | string | |
|
Posição da conta
|
data.account_position | string | |
|
Não assinado
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Relação de conta primária
|
data.primary_account_relationship | integer | |
|
Modificado por usuário
|
data.modified_by_user | string |
Atualizar o Lead
Modifica o lead ou os clientes potenciais com determinadas IDs.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID do cliente potencial
|
id | True | string |
ID |
|
Data de Criação
|
created | string | ||
|
Nome do lead
|
name | string | ||
|
Description
|
description | string | ||
|
Ranking
|
ranking | integer |
Número entre 1 e 100 |
|
|
ID do tipo de cliente potencial
|
lead_type_id | string |
ID |
|
|
ID da etapa
|
step_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | string |
ID |
|
|
ID do Proprietário
|
owner_id | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID do cliente potencial
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Tipo de lead
|
data.lead_type | string | |
|
Proprietário
|
data.owner | string | |
|
Motivo do fechamento
|
data.reason_of_close | string | |
|
Passo
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
Description
|
data.description | string | |
|
É arquivado
|
data.is_archived | boolean | |
|
Sinalizador de rótulo
|
data.label_flag | integer | |
|
ID do tipo de cliente potencial
|
data.lead_type_id | string | |
|
Nome do lead
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Email de conta rápida
|
data.quick_account_email | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Telefone de conta rápida
|
data.quick_account_phone | string | |
|
Nome do Contato Rápido
|
data.quick_contact_name | string | |
|
Email rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição de fechamento
|
data.reason_of_close_description | string | |
|
Motivo da ID de fechamento
|
data.reason_of_close_id | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
ID da etapa
|
data.step_id | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Revisão
|
data.revision | integer | |
|
Contato Principal
|
data.primary_contact | string | |
|
Conta primária
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Situação
|
data.status | integer |
1 - Aberto, 2 - Perdido, 4 - Qualificado |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Dias em etapa
|
data.days_in_step | integer | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Data perdida
|
data.lost_date | string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Criar conta
Cria uma nova conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
Nome da Conta
|
name | True | string | |
|
ID do Proprietário
|
owner_id | True | string |
ID |
|
ID do tipo de conta
|
account_type_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | string |
ID |
|
|
Classe Account
|
account_class | integer |
1 – Sem Classe, 2 – Classe A, 3 – Classe B, 4 – Classe C, 5 – Classe D |
|
|
Email primário
|
email1 | string |
Endereço de email |
|
|
Telefone Primário
|
phone1 | string |
Número de telefone |
|
|
Home page
|
home_page | string |
URL |
|
|
Endereço
|
address | string | ||
|
City
|
city | string | ||
|
País
|
country | string | ||
|
Estado/Província
|
state_province | string | ||
|
Código Postal
|
zip_code | string | ||
|
Comments
|
comments | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
AccountID
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data modificada
|
data.modified | string | |
|
Data criada
|
data.created | string | |
|
Tipo de conta
|
data.account_type | string | |
|
Tipo de cliente
|
data.customer_type | string | |
|
Setor
|
data.industry | string | |
|
Proprietário
|
data.owner | string | |
|
Conta pai
|
data.parent_account | string | |
|
Tipo de relação de conta pai
|
data.parent_account_relation_type | string | |
|
Picture
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Classe Account
|
data.account_class | integer | |
|
ID do tipo de conta
|
data.account_type_id | string | |
|
Endereço
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
País
|
data.country | string | |
|
ID do Tipo de Cliente
|
data.customer_type_id | string | |
|
Email primário
|
data.email1 | string | |
|
Email 2
|
data.email2 | string | |
|
Email 3
|
data.email3 | string | |
|
Email 4
|
data.email4 | string | |
|
Email 5
|
data.email5 | string | |
|
Categoria de integridade
|
data.health_category | string | |
|
Estado de saúde
|
data.health_status | integer | |
|
Página inicial
|
data.home_page | string | |
|
ID do setor
|
data.industry_id | string | |
|
Nome da Conta
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da conta pai
|
data.parent_account_id | string | |
|
ID do tipo de relação da conta pai
|
data.parent_account_relation_type_id | string | |
|
Telefone Primário
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID da imagem
|
data.picture_id | string | |
|
Nome da conta pai rápida
|
data.quick_parent_account_name | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Estado/Província
|
data.state_province | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Código Postal
|
data.zip_code | string | |
|
Revisão
|
data.revision | integer | |
|
Nome formatado
|
data.formatted_name | string | |
|
Mídias Sociais
|
data.social_media | string | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Não assinado
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Criar Contato
Cria um novo contato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
Título/Saudação
|
title | string | ||
|
Primeiro Nome
|
first_name | string | ||
|
Nome do Meio
|
middle_name | string | ||
|
Apelido
|
last_name | True | string | |
|
Gênero
|
gender | integer |
0 - Desconhecido, 1 - Masculino, 2 - Feminino, 3 - Não binário |
|
|
ID do tipo de contato
|
contact_type_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | string |
ID |
|
|
ID do Proprietário
|
owner_id | True | string |
ID |
|
Email
|
email1 | string |
Endereço de email |
|
|
Telefone
|
phone1 | string |
Número de telefone |
|
|
Endereço
|
address | string | ||
|
City
|
city | string | ||
|
Estado/Província
|
state_province | string | ||
|
Código Postal
|
zip_code | string | ||
|
País
|
country | string | ||
|
É Primário
|
is_primary | boolean | ||
|
AccountID
|
account_id | string |
ID |
|
|
Comments
|
comments | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID de contato
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data modificada
|
data.modified | string | |
|
Credo de Data
|
data.created | string | |
|
Tipo de contato
|
data.contact_type | string | |
|
Proprietário
|
data.owner | string | |
|
Picture
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Endereço
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
ID do tipo de contato
|
data.contact_type_id | string | |
|
País
|
data.country | string | |
|
Email primário
|
data.email1 | string | |
|
Email 2
|
data.email2 | string | |
|
Email 3
|
data.email3 | string | |
|
Email 4
|
data.email4 | string | |
|
Email 5
|
data.email5 | string | |
|
Primeiro Nome
|
data.first_name | string | |
|
Gênero
|
data.gender | integer |
0 - Desconhecido, 1 - Masculino, 2 - Feminino, 3 - Não binário |
|
Apelido
|
data.last_name | string | |
|
Nome do Meio
|
data.middle_name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Telefone Primário
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID da imagem
|
data.picture_id | string | |
|
Cargo
|
data.position | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Estado/Província
|
data.state_province | string | |
|
Title
|
data.title | string | |
|
ID da unidade
|
data.unit_id | string | |
|
Código Postal
|
data.zip_code | string | |
|
Revisão
|
data.revision | integer | |
|
Nome formatado
|
data.formatted_name | string | |
|
Mídias Sociais
|
data.social_media | string | |
|
Conta primária
|
data.primary_account | string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Funções de conta primária
|
data.primary_account_account_roles | array of string | |
|
Posição da conta primária
|
data.primary_account_position | string | |
|
Posição da conta
|
data.account_position | string | |
|
Não assinado
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Relação de conta primária
|
data.primary_account_relationship | integer | |
|
Modificado por usuário
|
data.modified_by_user | string |
Criar Lead
Cria um novo lead.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
Data de Criação
|
created | string |
Data e hora |
|
|
Description
|
description | string | ||
|
Ranking
|
ranking | integer |
Número entre 1 e 100 |
|
|
ID do tipo de cliente potencial
|
lead_type_id | string |
ID |
|
|
Nome do lead
|
name | True | string | |
|
ID do Proprietário
|
owner_id | True | string |
ID |
|
ID da etapa
|
step_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | True | string |
ID |
|
É Primário
|
is_primary | boolean | ||
|
ID de contato
|
contact_id | string |
ID |
|
|
É Primário
|
is_primary | boolean | ||
|
AccountID
|
account_id | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID do cliente potencial
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Tipo de lead
|
data.lead_type | string | |
|
Proprietário
|
data.owner | string | |
|
Motivo do fechamento
|
data.reason_of_close | string | |
|
Passo
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
Description
|
data.description | string | |
|
É arquivado
|
data.is_archived | boolean | |
|
Sinalizador de rótulo
|
data.label_flag | integer | |
|
ID do tipo de cliente potencial
|
data.lead_type_id | string | |
|
Nome do lead
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Email de conta rápida
|
data.quick_account_email | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Telefone de conta rápida
|
data.quick_account_phone | string | |
|
Nome do Contato Rápido
|
data.quick_contact_name | string | |
|
Email rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição de fechamento
|
data.reason_of_close_description | string | |
|
Motivo da ID de fechamento
|
data.reason_of_close_id | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
ID da etapa
|
data.step_id | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Revisão
|
data.revision | integer | |
|
Contato Principal
|
data.primary_contact | string | |
|
Conta primária
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Situação
|
data.status | integer |
1 - Aberto, 2 - Perdido, 4 - Qualificado |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Dias em etapa
|
data.days_in_step | integer | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Data perdida
|
data.lost_date | string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Criar oportunidade
Cria uma nova oportunidade.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
Nome da Oportunidade
|
name | True | string | |
|
Data de Criação
|
created | string | ||
|
Valor da oportunidade
|
base_value | True | number | |
|
Moeda
|
currency_id | True | string | |
|
Valor Estrangeiro
|
value_foreign | number | ||
|
Data de fechamento
|
closing_date | True | date | |
|
Description
|
description | string | ||
|
Ranking
|
ranking | integer |
Número entre 1 e 100 |
|
|
ID do tipo de oportunidade
|
oppty_type_id | True | string |
ID |
|
ID da etapa
|
step_id | True | string |
ID |
|
ID da unidade de vendas
|
unit_id | string |
ID |
|
|
ID do Proprietário
|
owner_id | True | string |
ID |
|
É Primário
|
is_primary | True | boolean | |
|
AccountID
|
account_id | True | string |
ID |
|
É Primário
|
is_primary | boolean | ||
|
ID de contato
|
contact_id | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID da oportunidade
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Cotação ativa
|
data.active_quote | string | |
|
Tipo de oportunidade
|
data.oppty_type | string | |
|
Proprietário
|
data.owner | string | |
|
Moeda do Produto
|
data.product_currency | string | |
|
Lista de Preços de Produtos
|
data.product_price_list | string | |
|
Motivo do fechamento
|
data.reason_of_close | string | |
|
Passo
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
ID da cotação ativa
|
data.active_quote_id | string | |
|
Data de encerramento
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
É arquivado
|
data.is_archived | boolean | |
|
O valor é calculado automaticamente
|
data.is_value_auto_calculate | boolean | |
|
Sinalizadores de rótulo
|
data.label_flag | integer | |
|
Nome da Oportunidade
|
data.name | string | |
|
ID do tipo de oportunidade
|
data.oppty_type_id | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da Moeda do Produto
|
data.product_currency_id | string | |
|
ID da Lista de Preços do Produto
|
data.product_price_list_id | string | |
|
Email de Conta Rápida
|
data.quick_account_email | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Telefone de conta rápida
|
data.quick_account_phone | string | |
|
Nome do Contato Rápido
|
data.quick_contact_name | string | |
|
Email Rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição de fechamento
|
data.reason_of_close_description | string | |
|
Motivo da ID de fechamento
|
data.reason_of_close_id | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
ID da etapa
|
data.step_id | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade
|
data.unit_id | string | |
|
Foi qualificado
|
data.was_qualified | boolean | |
|
Revisão
|
data.revision | integer | |
|
Valor base
|
data.value.base_value | number | |
|
ID da moeda
|
data.value.currency_id | string | |
|
Valor Estrangeiro
|
data.value.value_foreign | number | |
|
Recorrência de oportunidade
|
data.oppty_recurrence | string | |
|
Agendamento de Receita
|
data.revenue_schedule | string | |
|
Relações de produto
|
data.product_relations | array of string | |
|
Contato Principal
|
data.primary_contact | string | |
|
Contato Principal
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Documentos
|
data.documents | array of string | |
|
Relações entre aspas
|
data.quote_relations | array of string | |
|
Situação
|
data.status | integer | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Data de ganho
|
data.won_date | string | |
|
Data perdida
|
data.lost_date | string | |
|
Dias em etapa
|
data.days_in_step | integer | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Criar Tarefa
Cria uma nova tarefa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
Assunto
|
subject | True | string | |
|
ID do tipo de tarefa
|
activity_type_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | True | string |
ID |
|
ID do Proprietário
|
owner_id | True | string |
ID |
|
Description
|
description | string | ||
|
Data de vencimento
|
due_date | date | ||
|
Priority
|
priority | integer |
1 - Baixo, 2 - Médio, 3 - Alto |
|
|
Situação
|
status | integer |
1 – Não Iniciado, 2 – Em Andamento, 3 – Aguardando, 4 – Concluído, 5 – Adiado |
|
|
AccountID
|
account_id | string |
ID |
|
|
ID de contato
|
contact_id | string |
ID |
|
|
ID do cliente potencial
|
lead_oppty_id | string | ||
|
ID da oportunidade
|
lead_oppty_id | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID da Tarefa
|
data.id | string | |
|
Lembrete ativo
|
data.active_reminder | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Tipo de atividade
|
data.activity_type | string | |
|
Resultado da chamada
|
data.call_outcome | string | |
|
Proprietário
|
data.owner | string | |
|
Unidade
|
data.unit | string | |
|
ID do tipo de atividade
|
data.activity_type_id | string | |
|
Duração da chamada
|
data.call_duration | integer | |
|
ID do resultado da chamada
|
data.call_outcome_id | string | |
|
Description
|
data.description | string | |
|
Data de vencimento
|
data.due_date | string | |
|
Duração
|
data.duration | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Baixo, 2 - Médio, 3 - Alto |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Data de Início
|
data.start_date | string | |
|
Situação
|
data.status | integer |
1 – Não Iniciado, 2 – Em Andamento, 3 – Aguardando, 4 – Concluído, 5 – Adiado |
|
Assunto da tarefa
|
data.subject | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Revisão
|
data.revision | integer | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de liderança
|
data.lead_relations | array of string | |
|
Relações de Oportunidade
|
data.opportunity_relations | array of string | |
|
Relações de projeto
|
data.project_relations | array of string | |
|
Relações entre aspas
|
data.quote_relations | array of string | |
|
Lembrete
|
data.reminder | string | |
|
Recorrência da tarefa
|
data.task_recurrence | string | |
|
Documentos
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Excluir Conta
Remove a conta com determinada ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
AccountID
|
id | True | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
ID
|
data | string |
Excluir Contato
Remove o contato com a ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID de contato
|
id | True | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
ID
|
data | string |
Excluir Lead
Remove o cliente potencial com determinada ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID do cliente potencial
|
id | True | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
ID
|
data | string |
Excluir Oportunidade
Remove a oportunidade com a ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID da oportunidade
|
id | True | string |
ID da Oportunidade |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
ID
|
data | string |
Excluir Tarefa
Remove a tarefa com determinada ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID da Tarefa
|
id | True | string |
ID da tarefa |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
ID
|
data | string |
Obter conta
Retorna a conta com a ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
AccountID
|
id | True | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
AccountID
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Tipo de conta
|
data.account_type | string | |
|
Tipo de cliente
|
data.customer_type | string | |
|
Setor
|
data.industry | string | |
|
Proprietário
|
data.owner | string | |
|
Conta pai
|
data.parent_account | string | |
|
Tipo de relação de conta pai
|
data.parent_account_relation_type | string | |
|
Picture
|
data.picture | string | |
|
ID da unidade de vendas
|
data.unit | string | |
|
Classe Account
|
data.account_class | integer | |
|
ID do tipo de conta
|
data.account_type_id | string | |
|
Endereço
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
País
|
data.country | string | |
|
ID do Tipo de Cliente
|
data.customer_type_id | string | |
|
Email primário
|
data.email1 | string | |
|
Email 2
|
data.email2 | string | |
|
Email 3
|
data.email3 | string | |
|
Email 4
|
data.email4 | string | |
|
Email 5
|
data.email5 | string | |
|
Categoria de integridade
|
data.health_category | string | |
|
Estado de saúde
|
data.health_status | integer | |
|
Página inicial
|
data.home_page | string | |
|
ID do setor
|
data.industry_id | string | |
|
Nome da Conta
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da conta pai
|
data.parent_account_id | string | |
|
ID do tipo de relação da conta pai
|
data.parent_account_relation_type_id | string | |
|
Telefone Primário
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID da imagem
|
data.picture_id | string | |
|
Nome da conta pai rápida
|
data.quick_parent_account_name | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Estado/Província
|
data.state_province | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Código Postal
|
data.zip_code | string | |
|
Revisão
|
data.revision | integer | |
|
Nome formatado
|
data.formatted_name | string | |
|
Mídias Sociais
|
data.social_media | string | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Não assinado
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Obter contato
Retorna contato com a ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID de contato
|
id | True | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID de contato
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data modificada
|
data.modified | string | |
|
Credo de Data
|
data.created | string | |
|
Tipo de contato
|
data.contact_type | string | |
|
Proprietário
|
data.owner | string | |
|
Picture
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Endereço
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
ID do tipo de contato
|
data.contact_type_id | string | |
|
País
|
data.country | string | |
|
Email primário
|
data.email1 | string | |
|
Email 2
|
data.email2 | string | |
|
Email 3
|
data.email3 | string | |
|
Email 4
|
data.email4 | string | |
|
Email 5
|
data.email5 | string | |
|
Primeiro Nome
|
data.first_name | string | |
|
Apelido
|
data.last_name | string | |
|
Nome do Meio
|
data.middle_name | string | |
|
Gênero
|
data.gender | integer |
0 - Desconhecido, 1 - Masculino, 2 - Feminino, 3 - Não binário |
|
ID do Proprietário
|
data.owner_id | string | |
|
Telefone Primário
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID da imagem
|
data.picture_id | string | |
|
Cargo
|
data.position | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Estado/Província
|
data.state_province | string | |
|
Title
|
data.title | string | |
|
ID da unidade
|
data.unit_id | string | |
|
Código Postal
|
data.zip_code | string | |
|
Revisão
|
data.revision | integer | |
|
Nome formatado
|
data.formatted_name | string | |
|
Mídias Sociais
|
data.social_media | string | |
|
Conta primária
|
data.primary_account | string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Funções de conta primária
|
data.primary_account_account_roles | array of string | |
|
Posição da conta primária
|
data.primary_account_position | string | |
|
Posição da conta
|
data.account_position | string | |
|
Não assinado
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Relação de conta primária
|
data.primary_account_relationship | integer | |
|
Modificado por usuário
|
data.modified_by_user | string |
Obter o cliente potencial
Retorna o cliente potencial com determinada ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID do cliente potencial
|
id | True | string |
ID do lead |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID do cliente potencial
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Tipo de lead
|
data.lead_type | string | |
|
Proprietário
|
data.owner | string | |
|
Motivo do fechamento
|
data.reason_of_close | string | |
|
Passo
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
Description
|
data.description | string | |
|
É arquivado
|
data.is_archived | boolean | |
|
Sinalizador de rótulo
|
data.label_flag | integer | |
|
ID do tipo de cliente potencial
|
data.lead_type_id | string | |
|
Nome do lead
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Email de conta rápida
|
data.quick_account_email | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Telefone de conta rápida
|
data.quick_account_phone | string | |
|
Nome do Contato Rápido
|
data.quick_contact_name | string | |
|
Email rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição de fechamento
|
data.reason_of_close_description | string | |
|
Motivo da ID de fechamento
|
data.reason_of_close_id | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
ID da etapa
|
data.step_id | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Revisão
|
data.revision | integer | |
|
Contato Principal
|
data.primary_contact | string | |
|
Conta primária
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Situação
|
data.status | integer |
1 - Aberto, 2 - Perdido, 4 - Qualificado |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Documentos
|
data.documents | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Dias em etapa
|
data.days_in_step | integer | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Data perdida
|
data.lost_date | string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Obter oportunidade
Retorna a oportunidade com a ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID da oportunidade
|
id | True | string |
ID da Oportunidade |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID da oportunidade
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Cotação ativa
|
data.active_quote | string | |
|
Tipo de oportunidade
|
data.oppty_type | string | |
|
Proprietário
|
data.owner | string | |
|
Moeda do Produto
|
data.product_currency | string | |
|
Lista de Preços de Produtos
|
data.product_price_list | string | |
|
Motivo do fechamento
|
data.reason_of_close | string | |
|
Passo
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
ID da cotação ativa
|
data.active_quote_id | string | |
|
Data de encerramento
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
É arquivado
|
data.is_archived | boolean | |
|
O valor é calculado automaticamente
|
data.is_value_auto_calculate | boolean | |
|
Sinalizadores de rótulo
|
data.label_flag | integer | |
|
Nome da Oportunidade
|
data.name | string | |
|
ID do tipo de oportunidade
|
data.oppty_type_id | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da Moeda do Produto
|
data.product_currency_id | string | |
|
ID da Lista de Preços do Produto
|
data.product_price_list_id | string | |
|
Email de Conta Rápida
|
data.quick_account_email | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Telefone de conta rápida
|
data.quick_account_phone | string | |
|
Nome do Contato Rápido
|
data.quick_contact_name | string | |
|
Email Rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição de fechamento
|
data.reason_of_close_description | string | |
|
Motivo da ID de fechamento
|
data.reason_of_close_id | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
ID da etapa
|
data.step_id | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade
|
data.unit_id | string | |
|
Foi qualificado
|
data.was_qualified | boolean | |
|
Revisão
|
data.revision | integer | |
|
Valor base
|
data.value.base_value | number | |
|
ID da moeda
|
data.value.currency_id | string | |
|
Valor Estrangeiro
|
data.value.value_foreign | number | |
|
Recorrência de oportunidade
|
data.oppty_recurrence | string | |
|
Agendamento de Receita
|
data.revenue_schedule | string | |
|
Relações de produto
|
data.product_relations | array of string | |
|
Contato Principal
|
data.primary_contact | string | |
|
Contato Principal
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Documentos
|
data.documents | array of string | |
|
Relações entre aspas
|
data.quote_relations | array of string | |
|
Situação
|
data.status | integer | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Data de ganho
|
data.won_date | string | |
|
Data perdida
|
data.lost_date | string | |
|
Dias em etapa
|
data.days_in_step | integer | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Obter Tarefa
Obtenha a tarefa com a ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID da Tarefa
|
id | True | string |
ID da tarefa |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID da Tarefa
|
data.id | string | |
|
Lembrete ativo
|
data.active_reminder | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Tipo de atividade
|
data.activity_type | string | |
|
Resultado da chamada
|
data.call_outcome | string | |
|
Proprietário
|
data.owner | string | |
|
Unidade
|
data.unit | string | |
|
ID do tipo de atividade
|
data.activity_type_id | string | |
|
Duração da chamada
|
data.call_duration | integer | |
|
ID do resultado da chamada
|
data.call_outcome_id | string | |
|
Description
|
data.description | string | |
|
Data de vencimento
|
data.due_date | string | |
|
Duração
|
data.duration | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Baixo, 2 - Médio, 3 - Alto |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Data de Início
|
data.start_date | string | |
|
Situação
|
data.status | integer |
1 – Não Iniciado, 2 – Em Andamento, 3 – Aguardando, 4 – Concluído, 5 – Adiado |
|
Assunto da tarefa
|
data.subject | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Revisão
|
data.revision | integer | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de liderança
|
data.lead_relations | array of string | |
|
Relações de Oportunidade
|
data.opportunity_relations | array of string | |
|
Relações de projeto
|
data.project_relations | array of string | |
|
Relações entre aspas
|
data.quote_relations | array of string | |
|
Lembrete
|
data.reminder | string | |
|
Recorrência da tarefa
|
data.task_recurrence | string | |
|
Documentos
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Oportunidade de Atualização
Modifica oportunidades ou oportunidades com determinadas IDs.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID da oportunidade
|
id | True | string |
ID da Oportunidade |
|
Data de Criação
|
created | string | ||
|
Nome da Oportunidade
|
name | string | ||
|
Valor da oportunidade
|
base_value | number | ||
|
Moeda
|
currency_id | string | ||
|
Valor Estrangeiro
|
value_foreign | number | ||
|
Data de fechamento
|
closing_date | date | ||
|
Description
|
description | string | ||
|
Ranking
|
ranking | integer |
Número entre 1 e 100 |
|
|
ID do tipo de oportunidade
|
oppty_type_id | string |
ID |
|
|
ID da etapa
|
step_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | string |
ID |
|
|
ID do Proprietário
|
owner_id | string |
ID |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID da oportunidade
|
data.id | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Cotação ativa
|
data.active_quote | string | |
|
Tipo de oportunidade
|
data.oppty_type | string | |
|
Proprietário
|
data.owner | string | |
|
Moeda do Produto
|
data.product_currency | string | |
|
Lista de Preços de Produtos
|
data.product_price_list | string | |
|
Motivo do fechamento
|
data.reason_of_close | string | |
|
Passo
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
ID da cotação ativa
|
data.active_quote_id | string | |
|
Data de encerramento
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
É arquivado
|
data.is_archived | boolean | |
|
O valor é calculado automaticamente
|
data.is_value_auto_calculate | boolean | |
|
Sinalizadores de rótulo
|
data.label_flag | integer | |
|
Nome da Oportunidade
|
data.name | string | |
|
ID do tipo de oportunidade
|
data.oppty_type_id | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da Moeda do Produto
|
data.product_currency_id | string | |
|
ID da Lista de Preços do Produto
|
data.product_price_list_id | string | |
|
Email de Conta Rápida
|
data.quick_account_email | string | |
|
Nome da Conta Rápida
|
data.quick_account_name | string | |
|
Telefone de conta rápida
|
data.quick_account_phone | string | |
|
Nome do Contato Rápido
|
data.quick_contact_name | string | |
|
Email Rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição de fechamento
|
data.reason_of_close_description | string | |
|
Motivo da ID de fechamento
|
data.reason_of_close_id | string | |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
ID da etapa
|
data.step_id | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade
|
data.unit_id | string | |
|
Foi qualificado
|
data.was_qualified | boolean | |
|
Revisão
|
data.revision | integer | |
|
Valor base
|
data.value.base_value | number | |
|
ID da moeda
|
data.value.currency_id | string | |
|
Valor Estrangeiro
|
data.value.value_foreign | number | |
|
Recorrência de oportunidade
|
data.oppty_recurrence | string | |
|
Agendamento de Receita
|
data.revenue_schedule | string | |
|
Relações de produto
|
data.product_relations | array of string | |
|
Contato Principal
|
data.primary_contact | string | |
|
Contato Principal
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Documentos
|
data.documents | array of string | |
|
Relações entre aspas
|
data.quote_relations | array of string | |
|
Situação
|
data.status | integer | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Data de ganho
|
data.won_date | string | |
|
Data perdida
|
data.lost_date | string | |
|
Dias em etapa
|
data.days_in_step | integer | |
|
É Favorito
|
data.is_favorite | boolean | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |
Tarefa Atualizar
Modifica tarefas ou tarefas com determinadas IDs.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Serviço
|
service_url | True | string |
Sua URL de Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
Sua ID de espaço |
|
ID da Tarefa
|
id | True | string |
ID da tarefa |
|
Assunto
|
subject | string | ||
|
ID do tipo de tarefa
|
activity_type_id | string |
ID |
|
|
ID da unidade de vendas
|
unit_id | string |
ID |
|
|
ID do Proprietário
|
owner_id | string |
ID |
|
|
Description
|
description | string | ||
|
Data de vencimento
|
due_date | date | ||
|
Priority
|
priority | integer |
1 - Baixo, 2 - Médio, 3 - Alto |
|
|
Situação
|
status | integer |
1 – Não Iniciado, 2 – Em Andamento, 3 – Aguardando, 4 – Concluído, 5 – Adiado |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Êxito
|
success | boolean | |
|
É Excluído Protegido
|
data.is_delete_protected | boolean | |
|
ID da Tarefa
|
data.id | string | |
|
Lembrete ativo
|
data.active_reminder | string | |
|
Está Excluído
|
data.is_deleted | boolean | |
|
Data criada
|
data.created | string | |
|
Data modificada
|
data.modified | string | |
|
Tipo de atividade
|
data.activity_type | string | |
|
Resultado da chamada
|
data.call_outcome | string | |
|
Proprietário
|
data.owner | string | |
|
Unidade
|
data.unit | string | |
|
ID do tipo de atividade
|
data.activity_type_id | string | |
|
Duração da chamada
|
data.call_duration | integer | |
|
ID do resultado da chamada
|
data.call_outcome_id | string | |
|
Description
|
data.description | string | |
|
Data de vencimento
|
data.due_date | string | |
|
Duração
|
data.duration | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Baixo, 2 - Médio, 3 - Alto |
|
Modo de Compartilhamento
|
data.share_mode | integer | |
|
Data de Início
|
data.start_date | string | |
|
Situação
|
data.status | integer |
1 – Não Iniciado, 2 – Em Andamento, 3 – Aguardando, 4 – Concluído, 5 – Adiado |
|
Assunto da tarefa
|
data.subject | string | |
|
Nome da tabela
|
data.table_name | string | |
|
ID da unidade de vendas
|
data.unit_id | string | |
|
Revisão
|
data.revision | integer | |
|
Unidades de compartilhamento
|
data.sharing_units | array of string | |
|
Compartilhando clientes
|
data.sharing_clients | array of string | |
|
Relações de Conta
|
data.account_relations | array of string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações de liderança
|
data.lead_relations | array of string | |
|
Relações de Oportunidade
|
data.opportunity_relations | array of string | |
|
Relações de projeto
|
data.project_relations | array of string | |
|
Relações entre aspas
|
data.quote_relations | array of string | |
|
Lembrete
|
data.reminder | string | |
|
Recorrência da tarefa
|
data.task_recurrence | string | |
|
Documentos
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado por usuário
|
data.modified_by_user | string |