Jump to Content
Glossário
Status da API
Base de Conhecimento
Academy
API PipeRun Atendimentos
Home
Comece Aqui
Tutoriais
Endpoints da API
Changelog
Discussão
v1.0
Glossário
Status da API
Base de Conhecimento
Academy
API PipeRun Atendimentos
Endpoints da API
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Home
Comece Aqui
Tutoriais
Endpoints da API
Changelog
Discussão
Ver detalhes do template de proposta
Search
JUMP TO
CRM de Vendas
Glossário
Primeiros passos
Autenticação
Considerações - Autenticação
Validar token
get
Validar dados de login
post
Revogar token
delete
Arquivos
Listar arquivos
get
Ver detalhes do arquivo
get
Listar arquivos de oportunidade
get
Listar arquivos da empresa
get
Ver detalhes dos arquivos de pessoa
get
Adicionar arquivo
Deletar arquivo
delete
Assinaturas
Listar documentos enviados para assinaturas
get
Ver detalhes de documento enviado para assinatura
get
Listar assinaturas
get
Ver detalhes da assinatura
get
Adicionar documento para assinatura
post
Adicionar assinatura em documento
post
Deletar assinatura
delete
Atividades
Listar atividades
get
Buscar atividade
get
Adicionar atividade
post
Atualizar atividade
put
Deletar atividade
delete
Campos customizados
Listar campos customizados
get
Ver detalhes do campo customizado
get
Adicionar campos customizados
post
Atualizar campo customizado
put
Deletar campo customizado
delete
Características do item
Listar características dos itens
get
Ver detalhes da característica do item
get
Adicionar opções na característica do item
post
Adicionar característica do item
post
Atualizar característica do item
put
Deletar característica do item
delete
Categorias do item
Listar categorias de item
get
Query Parameters - Ver detalhes das categorias de item
Ver detalhes da categoria de item
get
Query Parameters - Ver detalhes da categoria de item
Adicionar categoria de item
post
Atualizar categoria de item
put
Deletar categoria de item
delete
Cidades
Listar cidades
get
Query Parameters - Listar cidades
CNAES
Listar CNAES
get
Contas
Listar contas de usuários
get
Query Parameters - Listar contas de usuários
E-mails
Listar e-mails
get
Query Parameters - Listar emails
Marcar e-mail como lido
put
Marcar e-mail como não lido
put
Arquivar e-mail
put
Mover e-mail para caixa de entrada
put
Deletar e-mail
delete
Empresas
Listar empresas
get
Query Parameters - Listar empresas
Ver detalhes da empresa
get
Query Parameters - Ver detalhes da empresa
Adicionar empresa
post
Atualizar empresa
put
Deletar empresa
delete
Equipes
Listar equipes
get
Query Parameters - Listar equipes
Ver detalhes da equipe
get
Query Parameters - Ver detalhes da equipe
Adicionar equipe
post
Atualizar equipe
put
Deletar equipe
delete
Estatísticas de oportunidades por usuário
Listar estatísticas de oportunidades por usuário
get
Query Parameters - Listar estatísticas de oportunidades por usuário
Listar estatísticas de oportunidades por etapa
get
Query Parameters - Listar estatísticas de oportunidades por etapa
Listar estatísticas de oportunidades por funil
get
Query Parameters - Listar estatísticas de oportunidades por funil
Etapas de funil
Listar etapas de funil
get
Query Parameters - Listar etapas de funil
Ver detalhes da etapa de funil
get
Query Parameters - Ver detalhes da etapa de funil
Adicionar etapa de funil
post
Atualizar etapa de funil
put
Deletar etapa de funil
delete
Formas de pagamento
Listar formas de pagamento
get
Query Parameters - Listar formas de pagamento
Ver detalhes da forma de pagamento
get
Adicionar forma de pagamento
post
Atualizar forma de pagamento
put
Deletar forma de pagamento
delete
Formulários customizados
Listar formulários customizados
get
Query Parameters - Listar formulários customizados
Ver detalhes do formulário customizado
get
Query Parameters - Ver detalhes do formulário customizado
Adicionar formulário customizado
post
Atualizar formulário customizado
put
Considerações - Tipo de campo nativo
Deletar formulário customizado
delete
Funis
Listar funis
get
Query Parameters - Listar funis
Ver detalhes do funil
get
Query Parameters - Ver detalhes do funil
Adicionar funil
post
Atualizar funil
put
Deletar funil
delete
Grupos de equipe
Listar grupos de equipe
get
Query Parameters - Listar grupos de equipe
Ver detalhes do grupo de equipe
get
Query Parameters - Ver detalhes do grupo de equipe
Adicionar grupo de equipe
post
Atualizar grupo de equipe
put
Deletar grupo de equipe
delete
Grupos de origens de oportunidades
Listar grupos de origens de oportunidades
get
Query Parameters - Listar grupos de origem
Ver detalhes do grupo de origens de oportunidades
get
Adicionar grupo de origens de oportunidades
post
Atualizar grupo de origens de oportunidades
put
Deletar grupo de origem
delete
Histórico de etapas de funil
Listar histórico de etapas de funil
get
Query Parameters - Listar histórico de etapas de funil
Histórico de ligações
Listar histórico de ligações
get
Query Parameters - Listar histórico de ligações
Ver detalhes do histórico de ligação
get
Query Parameters - Ver detalhes do histórico de ligação
Adicionar histórico de ligação
post
Atualizar histórico de ligação
put
Deletar histórico de ligação
delete
Itens
Listar itens
get
Query Parameters - Listar itens
Ver detalhes do item
get
Query Parameters - Ver detalhes do item
Adicionar item
post
Atualizar item
put
Deletar item
delete
Itens vinculados à oportunidade
Listar itens vinculados às oportunidades
get
Query Parameters - Listar itens da oportunidade
Ver detalhes do item vinculado à oportunidade
get
Adicionar item à oportunidade
post
Atualizar item vinculado à oportunidade
put
Deletar o item vinculado da oportunidade
delete
Lista de dados
Listar listas de dados
get
Query Parameters - Listar lista de dados
Ver detalhes da lista de dados
get
Query Parameters - Ver detalhes da lista de dados
Adicionar lista de dados
post
Atualizar lista de dados
put
Deletar lista de dados
delete
Listar campos de uma lista de dados
get
Adicionar campo em uma lista de dados
post
Atualizar campo em uma lista de dados
put
Deletar campo em uma lista de dados
delete
Listar opções de um campo de lista de dados
get
Adicionar opções em um campo de lista de dados
post
Atualizar opções em um campo de lista de dados
put
Deletar opção de um campo de lista de dados
delete
Listar registros de uma lista de dados
get
Adicionar registro em uma lista de dados
post
Atualizar registro de uma lista de dados
put
Deletar registro de uma lista de dados
delete
Metas avançadas
Listar metas avançadas
get
Ver detalhes da meta avançada
get
Ver estatísticas da meta avançada
get
Adicionar meta avançada
post
Atualizar meta avançada
put
Deletar meta avançada
delete
Modelos de propostas
Listar modelos de propostas
get
Query Parameters - Listar modelos de proposta
Ver detalhes do modelo de proposta
get
Adicionar modelo de proposta
post
Atualizar modelo de proposta
put
Deletar modelo de proposta
delete
Motivos de perda
Listar motivos de perda de oportunidade
get
Query Parameters - Listar motivos de perda de oportunidade
Ver detalhes do motivo de perda de oportunidade
get
Adicionar motivo de perda de oportunidade
post
Atualizar motivo de perda de oportunidade
put
Deletar motivo de perda de oportunidade
delete
Notas
Listar notas
get
Query Parameters - Listar notas
Ver detalhes da nota
get
Query Parameters - Ver detalhes da nota
Adicionar nota
post
Atualizar nota
put
Deletar nota
delete
Oportunidades
Listar oportunidades
get
Query Parameters - Listar oportunidades
Ver detalhes da oportunidade
get
Query Parameters - Ver detalhes da oportunidade
Adicionar oportunidade
post
Duplicar oportunidade
post
Atualizar oportunidade
put
Deletar oportunidade
delete
Origens de oportunidades
Listar origens de oportunidades
get
Query Parameters - Listar origens de oportunidades
Ver detalhes da origem de oportunidades
get
Adicionar origem de oportunidades
post
Atualizar origem de oportunidades
put
Deletar origem de oportunidades
delete
Outros contatos da oportunidade
Listar outros contatos da oportunidade
get
Query Parameters - Listar outros contatos da oportunidade
Atualizar outros contatos da oportunidade
put
Deletar outros contatos da oportunidade
delete
Pessoas
Listar pessoas
get
Query Parameters - Listar pessoas
Ver detalhes da pessoa
get
Query Parameters - Ver detalhes da pessoa
Adicionar pessoa
post
Atualizar pessoa
put
Deletar pessoa
delete
Propostas
Listar propostas
get
Query Parameters - Listar propostas
Ver detalhes da proposta
get
Query Parameters - Ver detalhes da proposta
Listar propostas de oportunidade
get
Adicionar proposta
post
Adicionar proposta usando template
post
Atualizar proposta
put
Gerar o PDF de uma proposta
put
Deletar proposta
delete
Pagamento de parcela de proposta
Listar pagamento de parcelas de propostas
get
Query Parameters - Listar pagamento de parcelas de propostas
Ver detalhes do pagamento de parcela de proposta
get
Adicionar pagamento de parcela de proposta
post
Regiões
Listar regiões
get
Query Parameters - Listar regiões
Ver detalhes da região
get
Query Parameters - Ver detalhes da região
Adicionar região
post
Atualizar região
put
Deletar região
delete
Respostas em lista de dados
Listar respostas de lista de dados
get
Query Parameters - Listar respostas de lista de dados
Ver detalhes de resposta de lista de dados
get
Adicionar resposta à lista de dados
post
Atualizar resposta de lista de dados
put
Deletar resposta de lista de dados
delete
Regras de preenchimento de campos
Adicionar regra de preenchimento de campos
post
Listagem de valores para o atributo "native_fields"
Listar regras de preenchimento de campos
get
Ver detalhes da regra de preenchimento de campo
get
Atualizar regra de preenchimento de campo
put
Deletar regra de preenchimento de campo
delete
Segmentos de empresas
Listar segmentos
get
Query Parameters - Listar segmentos
Ver detalhes do segmento
get
Adicionar segmentos
post
Atualizar segmento
put
Deletar segmento
delete
Siglas sequenciais de propostas
Listar siglas sequenciais de propostas
get
Query Parameters - Listar siglas sequenciais de propostas
Ver detalhes da sigla sequencial de propostas
get
Adicionar sigla sequencial de propostas
post
Atualizar sigla sequencial de propostas
put
Deletar sigla sequencial de propostas
delete
Tags
Listar tags
get
Query Parameters - Listar tags
Ver detalhes da tag
get
Query Parameters - Listar tags da empresa
Adicionar tag
post
Atualizar tag
put
Deletar tag
delete
Templates de e-mail
Listar templates de e-mail
get
Query Parameters - Listar templates de e-mail
Ver detalhes do template de e-mail
get
Adicionar template de e-mail
post
Atualizar template de e-mail
put
Deletar template de e-mail
delete
Templates de proposta
Listar templates de proposta
get
Query Parameters - Listar templates de proposta
Ver detalhes do template de proposta
get
Adicionar template de proposta
post
Atualizar template de proposta
put
Deletar template de proposta
delete
Tipos de atividades
Listar tipos de atividade
get
Query Parameters - Listar tipos de atividade
Ver detalhes do tipo da atividade
get
Query Parameters - Ver detalhes do tipo de atividade
Adicionar tipo de atividade
post
Atualizar tipo de atividade
put
Considerações - Ícones dos tipos de atividade
Deletar tipo de atividade
delete
Tipos de formas de pagamento
Listar tipos de formas de pagamento
get
Unidade de medida
Listar unidades de medida
get
Query Parameters - Listar unidades de medida
Ver detalhes da unidade de medida
get
Query Parameters - Ver detalhes da unidade de medida
Adicionar unidade de medida
post
Atualizar unidade de medida
put
Deletar unidade de medida
delete
Usuários
Listar usuários
get
Query Parameters - Listar usuários
Ver detalhes do usuário
get
Adicionar usuário
post
Atualizar usuário
put
Deletar usuário
delete
Powered by
Ver detalhes do template de proposta
get
https://api.pipe.run/v1/proposals/templates/
{template_id}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!