CRM do Pipeliner (Visualização)
O Pipeliner é um software de CRM de vendas de última geração projetado para capacitar as equipes de vendas e desenvolver relacionamentos lucrativos com os clientes. O conector fornece uma API para trabalhar com registros Pipeliner.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 | |
|---|---|
| Editora | Pipelinersales Corporação |
| Sítio Web | https://www.pipelinersales.com |
| Política de privacidade | https://www.pipelinersales.com/privacy/ |
| Categorias | Vendas e CRM; Produtividade |
Pipeliner CRM
O Pipeliner é um software de CRM de vendas de última geração projetado para capacitar as equipes de vendas e desenvolver relacionamentos lucrativos com os clientes. O conector fornece uma API para trabalhar com registros Pipeliner.
Editora: Pipelinersales, Inc.
Pré-requisitos
Credenciais básicas de autenticação de acesso para API.
Operações suportadas
Account
- Obter uma conta
- Criar uma conta
- Atualizar uma conta
- Excluir uma conta
Contato
- Obter um contacto
- Criar um contacto
- Atualizar um contato
- Excluir um contato
Liderança
- Obtenha um lead
- Crie um lead
- Atualizar um lead
- Excluir um lead
Oportunidade
- Obtenha uma oportunidade
- Criar uma oportunidade
- Atualizar uma oportunidade
- Excluir uma oportunidade
Tarefa
- Obter uma tarefa
- Criar uma tarefa
- Atualizar uma tarefa
- Excluir uma tarefa
Obtenção de credenciais
A API do Pipeliner CRM está usando a autenticação Básica, que consiste em Nome de usuário e Senha.
O usuário precisa fornecer URL de serviço e ID de espaço.
Problemas conhecidos e limitações
A API retorna um máximo de 100 registros por solicitação.
Instruções de implantação
N/A
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 utilizador | securestring | O nome de usuário para esta api | Verdade |
| Palavra-passe | securestring | A senha para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar conta |
Modifica a conta ou contas com determinados ID(s). |
| Atualizar contato |
Modifica o contacto ou contactos com determinados ID(s). |
| Criar Conta |
Cria uma nova conta. |
| Criar Contacto |
Cria um novo contato. |
| Criar Lead |
Cria um novo lead. |
| Criar Oportunidade |
Cria novas oportunidades. |
| Criar tarefa |
Cria uma nova tarefa. |
| Excluir conta |
Remove a conta com ID fornecido. |
| Excluir contato |
Remove o contato com determinado ID. |
| Excluir lead |
Remove o chumbo com determinado ID. |
| Excluir oportunidade |
Remove oportunidade com ID fornecido. |
| Excluir tarefa |
Remove a tarefa com determinada ID. |
| Lead de atualização |
Modifica leads ou leads com determinados ID(s). |
| Obter Conta |
Devolve conta com ID fornecido. |
| Obter contato |
Devolve o contacto com determinado ID. |
| Obter Lead |
Retorna lead com ID fornecido. |
| Obter Oportunidade |
Devolve oportunidade com ID fornecido. |
| Obter tarefa |
Obter tarefa com determinado ID. |
| Oportunidade de atualização |
Modifica oportunidade ou oportunidades com ID(s) fornecido(s). |
| Tarefa de atualização |
Modifica tarefas ou tarefas com determinados ID(s). |
Atualizar conta
Modifica a conta ou contas com determinados ID(s).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID da conta
|
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 da conta
|
account_class | integer |
1 - Sem classe, 2 - Classe A, 3 - Classe B, 4 - Classe C, 5 - Classe D |
|
|
E-mail principal
|
email1 | string |
Endereço de e-mail |
|
|
Telefone principal
|
phone1 | string |
Número de telefone |
|
|
Home page
|
home_page | string |
URL |
|
|
Address
|
address | string | ||
|
City
|
city | string | ||
|
Country
|
country | string | ||
|
Estado / Província
|
state_province | string | ||
|
Código Postal
|
zip_code | string | ||
|
Comments
|
comments | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da conta
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
data.modified | string | |
|
Tipo de Conta
|
data.account_type | string | |
|
Tipo de Cliente
|
data.customer_type | string | |
|
Indústria
|
data.industry | string | |
|
Proprietário
|
data.owner | string | |
|
Conta de Encarregado de Educação
|
data.parent_account | string | |
|
Tipo de relação de conta pai
|
data.parent_account_relation_type | string | |
|
Imagem
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Classe da conta
|
data.account_class | integer | |
|
ID do tipo de conta
|
data.account_type_id | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Country
|
data.country | string | |
|
ID do tipo de cliente
|
data.customer_type_id | string | |
|
E-mail principal
|
data.email1 | string | |
|
Correio Electrónico 2
|
data.email2 | string | |
|
Correio Electrónico 3
|
data.email3 | string | |
|
Correio eletrónico 4
|
data.email4 | string | |
|
Correio eletrónico 5
|
data.email5 | string | |
|
Categoria Saúde
|
data.health_category | string | |
|
Estado de saúde
|
data.health_status | integer | |
|
Página inicial
|
data.home_page | string | |
|
ID da Indústria
|
data.industry_id | string | |
|
Nome da Conta
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da conta de encarregado de educação
|
data.parent_account_id | string | |
|
ID do tipo de relação da conta pai
|
data.parent_account_relation_type_id | string | |
|
Telefone principal
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID com foto
|
data.picture_id | string | |
|
Nome da conta de pai rápido
|
data.quick_parent_account_name | string | |
|
Modo de Partilha
|
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 | |
|
Redes Sociais
|
data.social_media | string | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
É favorito
|
data.is_favorite | boolean | |
|
Não está subscrito
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Atualizar contato
Modifica o contacto ou contactos com determinados ID(s).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID de contato
|
id | True | string |
ID |
|
Título / Saudação
|
title | string | ||
|
Nome Próprio
|
first_name | string | ||
|
Segundo Nome
|
middle_name | string | ||
|
Apelido
|
last_name | string | ||
|
Sexo
|
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 |
|
|
E-mail
|
email1 | string |
Endereço de e-mail |
|
|
Telemóvel
|
phone1 | string |
Número de telefone |
|
|
Address
|
address | string | ||
|
City
|
city | string | ||
|
Estado / Província
|
state_province | string | ||
|
Código Postal
|
zip_code | string | ||
|
Country
|
country | string | ||
|
Comments
|
comments | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID de contato
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Modificação
|
data.modified | string | |
|
Data Creted
|
data.created | string | |
|
Tipo de Contacto
|
data.contact_type | string | |
|
Proprietário
|
data.owner | string | |
|
Imagem
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
ID do tipo de contato
|
data.contact_type_id | string | |
|
Country
|
data.country | string | |
|
E-mail principal
|
data.email1 | string | |
|
Correio Electrónico 2
|
data.email2 | string | |
|
Correio Electrónico 3
|
data.email3 | string | |
|
Correio eletrónico 4
|
data.email4 | string | |
|
Correio eletrónico 5
|
data.email5 | string | |
|
Nome Próprio
|
data.first_name | string | |
|
Apelido
|
data.last_name | string | |
|
Segundo Nome
|
data.middle_name | string | |
|
Sexo
|
data.gender | integer |
0 - Desconhecido, 1 - Masculino, 2 - Feminino, 3 - Não-binário |
|
ID do Proprietário
|
data.owner_id | string | |
|
Telefone principal
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID com foto
|
data.picture_id | string | |
|
Position
|
data.position | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Modo de Partilha
|
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 | |
|
Redes Sociais
|
data.social_media | string | |
|
Conta Principal
|
data.primary_account | string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
É favorito
|
data.is_favorite | boolean | |
|
Funções da conta principal
|
data.primary_account_account_roles | array of string | |
|
Posição da conta principal
|
data.primary_account_position | string | |
|
Posição da conta
|
data.account_position | string | |
|
Não está subscrito
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Relacionamento com a conta principal
|
data.primary_account_relationship | integer | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Criar Conta
Cria uma nova conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu 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 da conta
|
account_class | integer |
1 - Sem classe, 2 - Classe A, 3 - Classe B, 4 - Classe C, 5 - Classe D |
|
|
E-mail principal
|
email1 | string |
Endereço de e-mail |
|
|
Telefone principal
|
phone1 | string |
Número de telefone |
|
|
Home page
|
home_page | string |
URL |
|
|
Address
|
address | string | ||
|
City
|
city | string | ||
|
Country
|
country | string | ||
|
Estado / Província
|
state_province | string | ||
|
Código Postal
|
zip_code | string | ||
|
Comments
|
comments | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da conta
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Modificação
|
data.modified | string | |
|
Data de Criação
|
data.created | string | |
|
Tipo de Conta
|
data.account_type | string | |
|
Tipo de Cliente
|
data.customer_type | string | |
|
Indústria
|
data.industry | string | |
|
Proprietário
|
data.owner | string | |
|
Conta de Encarregado de Educação
|
data.parent_account | string | |
|
Tipo de relação de conta pai
|
data.parent_account_relation_type | string | |
|
Imagem
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Classe da conta
|
data.account_class | integer | |
|
ID do tipo de conta
|
data.account_type_id | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Country
|
data.country | string | |
|
ID do tipo de cliente
|
data.customer_type_id | string | |
|
E-mail principal
|
data.email1 | string | |
|
Correio Electrónico 2
|
data.email2 | string | |
|
Correio Electrónico 3
|
data.email3 | string | |
|
Correio eletrónico 4
|
data.email4 | string | |
|
Correio eletrónico 5
|
data.email5 | string | |
|
Categoria Saúde
|
data.health_category | string | |
|
Estado de saúde
|
data.health_status | integer | |
|
Página inicial
|
data.home_page | string | |
|
ID da Indústria
|
data.industry_id | string | |
|
Nome da Conta
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da conta de encarregado de educação
|
data.parent_account_id | string | |
|
ID do tipo de relação da conta pai
|
data.parent_account_relation_type_id | string | |
|
Telefone principal
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID com foto
|
data.picture_id | string | |
|
Nome da conta de pai rápido
|
data.quick_parent_account_name | string | |
|
Modo de Partilha
|
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 | |
|
Redes Sociais
|
data.social_media | string | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
É favorito
|
data.is_favorite | boolean | |
|
Não está subscrito
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Criar Contacto
Cria um novo contato.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
Título / Saudação
|
title | string | ||
|
Nome Próprio
|
first_name | string | ||
|
Segundo Nome
|
middle_name | string | ||
|
Apelido
|
last_name | True | string | |
|
Sexo
|
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 |
|
E-mail
|
email1 | string |
Endereço de e-mail |
|
|
Telemóvel
|
phone1 | string |
Número de telefone |
|
|
Address
|
address | string | ||
|
City
|
city | string | ||
|
Estado / Província
|
state_province | string | ||
|
Código Postal
|
zip_code | string | ||
|
Country
|
country | string | ||
|
É primário
|
is_primary | boolean | ||
|
ID da conta
|
account_id | string |
ID |
|
|
Comments
|
comments | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID de contato
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Modificação
|
data.modified | string | |
|
Data Creted
|
data.created | string | |
|
Tipo de Contacto
|
data.contact_type | string | |
|
Proprietário
|
data.owner | string | |
|
Imagem
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
ID do tipo de contato
|
data.contact_type_id | string | |
|
Country
|
data.country | string | |
|
E-mail principal
|
data.email1 | string | |
|
Correio Electrónico 2
|
data.email2 | string | |
|
Correio Electrónico 3
|
data.email3 | string | |
|
Correio eletrónico 4
|
data.email4 | string | |
|
Correio eletrónico 5
|
data.email5 | string | |
|
Nome Próprio
|
data.first_name | string | |
|
Sexo
|
data.gender | integer |
0 - Desconhecido, 1 - Masculino, 2 - Feminino, 3 - Não-binário |
|
Apelido
|
data.last_name | string | |
|
Segundo Nome
|
data.middle_name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Telefone principal
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID com foto
|
data.picture_id | string | |
|
Position
|
data.position | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Modo de Partilha
|
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 | |
|
Redes Sociais
|
data.social_media | string | |
|
Conta Principal
|
data.primary_account | string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
É favorito
|
data.is_favorite | boolean | |
|
Funções da conta principal
|
data.primary_account_account_roles | array of string | |
|
Posição da conta principal
|
data.primary_account_position | string | |
|
Posição da conta
|
data.account_position | string | |
|
Não está subscrito
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Relacionamento com a conta principal
|
data.primary_account_relationship | integer | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Criar Lead
Cria um novo lead.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu 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 lead
|
lead_type_id | string |
ID |
|
|
Nome do Lead
|
name | True | string | |
|
ID do Proprietário
|
owner_id | True | string |
ID |
|
ID do passo
|
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 | ||
|
ID da conta
|
account_id | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
Lead ID
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
data.modified | string | |
|
Tipo de chumbo
|
data.lead_type | string | |
|
Proprietário
|
data.owner | string | |
|
Motivo do Encerramento
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
Description
|
data.description | string | |
|
Está arquivado
|
data.is_archived | boolean | |
|
Sinalizador de rótulo
|
data.label_flag | integer | |
|
ID do tipo de lead
|
data.lead_type_id | string | |
|
Nome do Lead
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
E-mail de Conta Rápida
|
data.quick_account_email | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Telefone de Conta Rápida
|
data.quick_account_phone | string | |
|
Nome de contato rápido
|
data.quick_contact_name | string | |
|
E-mail rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição próxima
|
data.reason_of_close_description | string | |
|
Motivo do Close ID
|
data.reason_of_close_id | string | |
|
Modo de Partilha
|
data.share_mode | integer | |
|
ID do passo
|
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 | |
|
Contacto Primário
|
data.primary_contact | string | |
|
Conta Principal
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Situação
|
data.status | integer |
1 - Aberto, 2 - Perdido, 4 - Qualificado |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Dias em passo
|
data.days_in_step | integer | |
|
É favorito
|
data.is_favorite | boolean | |
|
Data perdida
|
data.lost_date | string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Criar Oportunidade
Cria novas oportunidades.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu 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 encerramento
|
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 do passo
|
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 | |
|
ID da conta
|
account_id | True | string |
ID |
|
É primário
|
is_primary | boolean | ||
|
ID de contato
|
contact_id | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da oportunidade
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
data.modified | string | |
|
Cotação Ativa
|
data.active_quote | string | |
|
Tipo de Oportunidade
|
data.oppty_type | string | |
|
Proprietário
|
data.owner | string | |
|
Produto Currenct
|
data.product_currency | string | |
|
Lista de Preços de Produtos
|
data.product_price_list | string | |
|
Motivo do Encerramento
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
ID de cotação ativa
|
data.active_quote_id | string | |
|
Data de encerramento
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
Está arquivado
|
data.is_archived | boolean | |
|
É Valor Cálculo Automático
|
data.is_value_auto_calculate | boolean | |
|
Sinalizadores de etiquetas
|
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 | |
|
E-mail de conta rápida
|
data.quick_account_email | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Telefone de Conta Rápida
|
data.quick_account_phone | string | |
|
Nome de contato rápido
|
data.quick_contact_name | string | |
|
E-mail rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição próxima
|
data.reason_of_close_description | string | |
|
Motivo do Close ID
|
data.reason_of_close_id | string | |
|
Modo de Partilha
|
data.share_mode | integer | |
|
ID do passo
|
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 Oportunidades
|
data.oppty_recurrence | string | |
|
Calendário de Receitas
|
data.revenue_schedule | string | |
|
Relações com produtos
|
data.product_relations | array of string | |
|
Contacto Primário
|
data.primary_contact | string | |
|
Contacto Primário
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Documents
|
data.documents | array of string | |
|
Relações de Cotação
|
data.quote_relations | array of string | |
|
Situação
|
data.status | integer | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Data de Vitória
|
data.won_date | string | |
|
Data perdida
|
data.lost_date | string | |
|
Dias em passo
|
data.days_in_step | integer | |
|
É favorito
|
data.is_favorite | boolean | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo Usuário
|
data.modified_by_user | string |
Criar tarefa
Cria uma nova tarefa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu 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 Para Conclusão
|
due_date | date | ||
|
Priority
|
priority | integer |
1 - Baixa, 2 - Média, 3 - Alta |
|
|
Situação
|
status | integer |
1 - Não iniciado, 2 - Em andamento, 3 - Em espera, 4 - Concluído, 5 - Adiado |
|
|
ID da conta
|
account_id | string |
ID |
|
|
ID de contato
|
contact_id | string |
ID |
|
|
Lead ID
|
lead_oppty_id | string | ||
|
ID da oportunidade
|
lead_oppty_id | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da tarefa
|
data.id | string | |
|
Lembrete ativo
|
data.active_reminder | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
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 Para Conclusão
|
data.due_date | string | |
|
Duração
|
data.duration | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Baixa, 2 - Média, 3 - Alta |
|
Modo de Partilha
|
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 - Em espera, 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 Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com Leads
|
data.lead_relations | array of string | |
|
Relações de Oportunidade
|
data.opportunity_relations | array of string | |
|
Relações com Projetos
|
data.project_relations | array of string | |
|
Relações de Cotação
|
data.quote_relations | array of string | |
|
Lembrete
|
data.reminder | string | |
|
Recorrência de tarefas
|
data.task_recurrence | string | |
|
Documents
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Excluir conta
Remove a conta com ID fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID da conta
|
id | True | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
ID
|
data | string |
Excluir contato
Remove o contato com determinado ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID de contato
|
id | True | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
ID
|
data | string |
Excluir lead
Remove o chumbo com determinado ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
Lead ID
|
id | True | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
ID
|
data | string |
Excluir oportunidade
Remove oportunidade com ID fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID da oportunidade
|
id | True | string |
ID da Oportunidade |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
ID
|
data | string |
Excluir tarefa
Remove a tarefa com determinada ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID da tarefa
|
id | True | string |
ID da tarefa |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
ID
|
data | string |
Lead de atualização
Modifica leads ou leads com determinados ID(s).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
Lead ID
|
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 lead
|
lead_type_id | string |
ID |
|
|
ID do passo
|
step_id | string |
ID |
|
|
ID da Unidade de Vendas
|
unit_id | string |
ID |
|
|
ID do Proprietário
|
owner_id | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
Lead ID
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
data.modified | string | |
|
Tipo de chumbo
|
data.lead_type | string | |
|
Proprietário
|
data.owner | string | |
|
Motivo do Encerramento
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
Description
|
data.description | string | |
|
Está arquivado
|
data.is_archived | boolean | |
|
Sinalizador de rótulo
|
data.label_flag | integer | |
|
ID do tipo de lead
|
data.lead_type_id | string | |
|
Nome do Lead
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
E-mail de Conta Rápida
|
data.quick_account_email | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Telefone de Conta Rápida
|
data.quick_account_phone | string | |
|
Nome de contato rápido
|
data.quick_contact_name | string | |
|
E-mail rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição próxima
|
data.reason_of_close_description | string | |
|
Motivo do Close ID
|
data.reason_of_close_id | string | |
|
Modo de Partilha
|
data.share_mode | integer | |
|
ID do passo
|
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 | |
|
Contacto Primário
|
data.primary_contact | string | |
|
Conta Principal
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Situação
|
data.status | integer |
1 - Aberto, 2 - Perdido, 4 - Qualificado |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Dias em passo
|
data.days_in_step | integer | |
|
É favorito
|
data.is_favorite | boolean | |
|
Data perdida
|
data.lost_date | string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Obter Conta
Devolve conta com ID fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID da conta
|
id | True | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da conta
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
data.modified | string | |
|
Tipo de Conta
|
data.account_type | string | |
|
Tipo de Cliente
|
data.customer_type | string | |
|
Indústria
|
data.industry | string | |
|
Proprietário
|
data.owner | string | |
|
Conta de Encarregado de Educação
|
data.parent_account | string | |
|
Tipo de relação de conta pai
|
data.parent_account_relation_type | string | |
|
Imagem
|
data.picture | string | |
|
ID da Unidade de Vendas
|
data.unit | string | |
|
Classe da conta
|
data.account_class | integer | |
|
ID do tipo de conta
|
data.account_type_id | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
Country
|
data.country | string | |
|
ID do tipo de cliente
|
data.customer_type_id | string | |
|
E-mail principal
|
data.email1 | string | |
|
Correio Electrónico 2
|
data.email2 | string | |
|
Correio Electrónico 3
|
data.email3 | string | |
|
Correio eletrónico 4
|
data.email4 | string | |
|
Correio eletrónico 5
|
data.email5 | string | |
|
Categoria Saúde
|
data.health_category | string | |
|
Estado de saúde
|
data.health_status | integer | |
|
Página inicial
|
data.home_page | string | |
|
ID da Indústria
|
data.industry_id | string | |
|
Nome da Conta
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
ID da conta de encarregado de educação
|
data.parent_account_id | string | |
|
ID do tipo de relação da conta pai
|
data.parent_account_relation_type_id | string | |
|
Telefone principal
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID com foto
|
data.picture_id | string | |
|
Nome da conta de pai rápido
|
data.quick_parent_account_name | string | |
|
Modo de Partilha
|
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 | |
|
Redes Sociais
|
data.social_media | string | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
É favorito
|
data.is_favorite | boolean | |
|
Não está subscrito
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Obter contato
Devolve o contacto com determinado ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID de contato
|
id | True | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID de contato
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Modificação
|
data.modified | string | |
|
Data Creted
|
data.created | string | |
|
Tipo de Contacto
|
data.contact_type | string | |
|
Proprietário
|
data.owner | string | |
|
Imagem
|
data.picture | string | |
|
Unidade
|
data.unit | string | |
|
Address
|
data.address | string | |
|
City
|
data.city | string | |
|
Comments
|
data.comments | string | |
|
ID do tipo de contato
|
data.contact_type_id | string | |
|
Country
|
data.country | string | |
|
E-mail principal
|
data.email1 | string | |
|
Correio Electrónico 2
|
data.email2 | string | |
|
Correio Electrónico 3
|
data.email3 | string | |
|
Correio eletrónico 4
|
data.email4 | string | |
|
Correio eletrónico 5
|
data.email5 | string | |
|
Nome Próprio
|
data.first_name | string | |
|
Apelido
|
data.last_name | string | |
|
Segundo Nome
|
data.middle_name | string | |
|
Sexo
|
data.gender | integer |
0 - Desconhecido, 1 - Masculino, 2 - Feminino, 3 - Não-binário |
|
ID do Proprietário
|
data.owner_id | string | |
|
Telefone principal
|
data.phone1 | string | |
|
Telefone 2
|
data.phone2 | string | |
|
Telefone 3
|
data.phone3 | string | |
|
Telefone 4
|
data.phone4 | string | |
|
Telefone 5
|
data.phone5 | string | |
|
ID com foto
|
data.picture_id | string | |
|
Position
|
data.position | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Modo de Partilha
|
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 | |
|
Redes Sociais
|
data.social_media | string | |
|
Conta Principal
|
data.primary_account | string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
É favorito
|
data.is_favorite | boolean | |
|
Funções da conta principal
|
data.primary_account_account_roles | array of string | |
|
Posição da conta principal
|
data.primary_account_position | string | |
|
Posição da conta
|
data.account_position | string | |
|
Não está subscrito
|
data.is_unsubscribed | boolean | |
|
Etiquetas
|
data.tags | array of string | |
|
Relacionamento com a conta principal
|
data.primary_account_relationship | integer | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Obter Lead
Retorna lead com ID fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
Lead ID
|
id | True | string |
ID do lead |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
Lead ID
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
data.modified | string | |
|
Tipo de chumbo
|
data.lead_type | string | |
|
Proprietário
|
data.owner | string | |
|
Motivo do Encerramento
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
Description
|
data.description | string | |
|
Está arquivado
|
data.is_archived | boolean | |
|
Sinalizador de rótulo
|
data.label_flag | integer | |
|
ID do tipo de lead
|
data.lead_type_id | string | |
|
Nome do Lead
|
data.name | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
E-mail de Conta Rápida
|
data.quick_account_email | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Telefone de Conta Rápida
|
data.quick_account_phone | string | |
|
Nome de contato rápido
|
data.quick_contact_name | string | |
|
E-mail rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição próxima
|
data.reason_of_close_description | string | |
|
Motivo do Close ID
|
data.reason_of_close_id | string | |
|
Modo de Partilha
|
data.share_mode | integer | |
|
ID do passo
|
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 | |
|
Contacto Primário
|
data.primary_contact | string | |
|
Conta Principal
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Situação
|
data.status | integer |
1 - Aberto, 2 - Perdido, 4 - Qualificado |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Documents
|
data.documents | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Dias em passo
|
data.days_in_step | integer | |
|
É favorito
|
data.is_favorite | boolean | |
|
Data perdida
|
data.lost_date | string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Obter Oportunidade
Devolve oportunidade com ID fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID da oportunidade
|
id | True | string |
ID da Oportunidade |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da oportunidade
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
data.modified | string | |
|
Cotação Ativa
|
data.active_quote | string | |
|
Tipo de Oportunidade
|
data.oppty_type | string | |
|
Proprietário
|
data.owner | string | |
|
Produto Currenct
|
data.product_currency | string | |
|
Lista de Preços de Produtos
|
data.product_price_list | string | |
|
Motivo do Encerramento
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
ID de cotação ativa
|
data.active_quote_id | string | |
|
Data de encerramento
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
Está arquivado
|
data.is_archived | boolean | |
|
É Valor Cálculo Automático
|
data.is_value_auto_calculate | boolean | |
|
Sinalizadores de etiquetas
|
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 | |
|
E-mail de conta rápida
|
data.quick_account_email | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Telefone de Conta Rápida
|
data.quick_account_phone | string | |
|
Nome de contato rápido
|
data.quick_contact_name | string | |
|
E-mail rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição próxima
|
data.reason_of_close_description | string | |
|
Motivo do Close ID
|
data.reason_of_close_id | string | |
|
Modo de Partilha
|
data.share_mode | integer | |
|
ID do passo
|
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 Oportunidades
|
data.oppty_recurrence | string | |
|
Calendário de Receitas
|
data.revenue_schedule | string | |
|
Relações com produtos
|
data.product_relations | array of string | |
|
Contacto Primário
|
data.primary_contact | string | |
|
Contacto Primário
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Documents
|
data.documents | array of string | |
|
Relações de Cotação
|
data.quote_relations | array of string | |
|
Situação
|
data.status | integer | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Data de Vitória
|
data.won_date | string | |
|
Data perdida
|
data.lost_date | string | |
|
Dias em passo
|
data.days_in_step | integer | |
|
É favorito
|
data.is_favorite | boolean | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo Usuário
|
data.modified_by_user | string |
Obter tarefa
Obter tarefa com determinado ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu ID de Espaço |
|
ID da tarefa
|
id | True | string |
ID da tarefa |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da tarefa
|
data.id | string | |
|
Lembrete ativo
|
data.active_reminder | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
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 Para Conclusão
|
data.due_date | string | |
|
Duração
|
data.duration | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Baixa, 2 - Média, 3 - Alta |
|
Modo de Partilha
|
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 - Em espera, 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 Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com Leads
|
data.lead_relations | array of string | |
|
Relações de Oportunidade
|
data.opportunity_relations | array of string | |
|
Relações com Projetos
|
data.project_relations | array of string | |
|
Relações de Cotação
|
data.quote_relations | array of string | |
|
Lembrete
|
data.reminder | string | |
|
Recorrência de tarefas
|
data.task_recurrence | string | |
|
Documents
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |
Oportunidade de atualização
Modifica oportunidade ou oportunidades com ID(s) fornecido(s).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu 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 encerramento
|
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 do passo
|
step_id | string |
ID |
|
|
ID da Unidade de Vendas
|
unit_id | string |
ID |
|
|
ID do Proprietário
|
owner_id | string |
ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da oportunidade
|
data.id | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
data.modified | string | |
|
Cotação Ativa
|
data.active_quote | string | |
|
Tipo de Oportunidade
|
data.oppty_type | string | |
|
Proprietário
|
data.owner | string | |
|
Produto Currenct
|
data.product_currency | string | |
|
Lista de Preços de Produtos
|
data.product_price_list | string | |
|
Motivo do Encerramento
|
data.reason_of_close | string | |
|
Step
|
data.step | string | |
|
Unidade
|
data.unit | string | |
|
ID de cotação ativa
|
data.active_quote_id | string | |
|
Data de encerramento
|
data.closing_date | string | |
|
Description
|
data.description | string | |
|
Está arquivado
|
data.is_archived | boolean | |
|
É Valor Cálculo Automático
|
data.is_value_auto_calculate | boolean | |
|
Sinalizadores de etiquetas
|
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 | |
|
E-mail de conta rápida
|
data.quick_account_email | string | |
|
Nome Rápido da Conta
|
data.quick_account_name | string | |
|
Telefone de Conta Rápida
|
data.quick_account_phone | string | |
|
Nome de contato rápido
|
data.quick_contact_name | string | |
|
E-mail rápido
|
data.quick_email | string | |
|
Telefone Rápido
|
data.quick_phone | string | |
|
Ranking
|
data.ranking | integer | |
|
Motivo da descrição próxima
|
data.reason_of_close_description | string | |
|
Motivo do Close ID
|
data.reason_of_close_id | string | |
|
Modo de Partilha
|
data.share_mode | integer | |
|
ID do passo
|
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 Oportunidades
|
data.oppty_recurrence | string | |
|
Calendário de Receitas
|
data.revenue_schedule | string | |
|
Relações com produtos
|
data.product_relations | array of string | |
|
Contacto Primário
|
data.primary_contact | string | |
|
Contacto Primário
|
data.primary_account | string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Documents
|
data.documents | array of string | |
|
Relações de Cotação
|
data.quote_relations | array of string | |
|
Situação
|
data.status | integer | |
|
Data de qualificação
|
data.qualify_date | string | |
|
Data de Vitória
|
data.won_date | string | |
|
Data perdida
|
data.lost_date | string | |
|
Dias em passo
|
data.days_in_step | integer | |
|
É favorito
|
data.is_favorite | boolean | |
|
Unidades de Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Etiquetas
|
data.tags | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo Usuário
|
data.modified_by_user | string |
Tarefa de atualização
Modifica tarefas ou tarefas com determinados ID(s).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URL do serviço
|
service_url | True | string |
O URL do seu Serviço começando com https:// |
|
ID do espaço
|
space_id | True | string |
O seu 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 Para Conclusão
|
due_date | date | ||
|
Priority
|
priority | integer |
1 - Baixa, 2 - Média, 3 - Alta |
|
|
Situação
|
status | integer |
1 - Não iniciado, 2 - Em andamento, 3 - Em espera, 4 - Concluído, 5 - Adiado |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Sucesso
|
success | boolean | |
|
A exclusão é protegida
|
data.is_delete_protected | boolean | |
|
ID da tarefa
|
data.id | string | |
|
Lembrete ativo
|
data.active_reminder | string | |
|
É suprimido
|
data.is_deleted | boolean | |
|
Data de Criação
|
data.created | string | |
|
Data de Modificação
|
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 Para Conclusão
|
data.due_date | string | |
|
Duração
|
data.duration | string | |
|
ID do Proprietário
|
data.owner_id | string | |
|
Priority
|
data.priority | integer |
1 - Baixa, 2 - Média, 3 - Alta |
|
Modo de Partilha
|
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 - Em espera, 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 Partilha
|
data.sharing_units | array of string | |
|
Compartilhamento de clientes
|
data.sharing_clients | array of string | |
|
Relações com a Conta
|
data.account_relations | array of string | |
|
Relações de Contato
|
data.contact_relations | array of string | |
|
Relações com Leads
|
data.lead_relations | array of string | |
|
Relações de Oportunidade
|
data.opportunity_relations | array of string | |
|
Relações com Projetos
|
data.project_relations | array of string | |
|
Relações de Cotação
|
data.quote_relations | array of string | |
|
Lembrete
|
data.reminder | string | |
|
Recorrência de tarefas
|
data.task_recurrence | string | |
|
Documents
|
data.documents | array of string | |
|
Comments
|
data.comments | array of string | |
|
Nome formatado
|
data.formatted_name | string | |
|
Modificado pelo usuário
|
data.modified_by_user | string |