Opportunities

Módulo de Gestão de Opportunidades (Kanban). Este recurso é dependente do ID do módulo de gestão de oportunidades associado ao projeto, referenciado como component_id ao longo da documentação. Para saber qual é o ID correto a ser usado por este recurso faça uma busca na lista de components do projeto!

Listagem de oportunidades

get

Retorna uma lista de oportunidades para um dado componente.

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

Parámetros de consulta
pageinteger · intOpcional

número da página

limitinteger · intOpcional

número máximo de items na página (máx. 100)

Respuestas
chevron-right
200

Sucesso

application/json
get
/kanban/api/v1/{component_id}/opportunities

Criação de oportunidade

post

Cria uma oportunidade em um componente.

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

Cuerpo
attributesobjectRequerido

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Respuestas
post
/kanban/api/v1/{component_id}/opportunities

Dados da oportunidade

get

Retorna os dados de uma oportunidade de um componente.

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

Respuestas
chevron-right
200

Sucesso

application/json
idstring · uuidRequerido

ID da oportunidade

created_atstring · date-timeRequerido

Data de criação

updated_atstring · date-timeRequerido

Data da última atualização

discarded_atstring · date-timeOpcional

Data que foi descartada

attributesobjectRequerido

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Example: {"Status":"Em contato","Prioridade":"Alta"}
get
/kanban/api/v1/{component_id}/opportunities/{opportunity_id}

Excluir Oportunidade

delete

Excluir uma oportunidade de um determinado componente. A oportunidade não pode ser visualizada, modificada ou recuperada ao ser excluída!

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

Respuestas
chevron-right
200

Sucesso

application/json
idstring · uuidRequerido

ID da oportunidade

created_atstring · date-timeRequerido

Data de criação

updated_atstring · date-timeRequerido

Data da última atualização

discarded_atstring · date-timeOpcional

Data que foi descartada

attributesobjectRequerido

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Example: {"Status":"Em contato","Prioridade":"Alta"}
delete
/kanban/api/v1/{component_id}/opportunities/{opportunity_id}

Atualização de oportunidade

patch

Atualiza os dados de uma oportunindade de um componente. Afeta somente atributos que estão no corpo da requisição.

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

Cuerpo
attributesobjectRequerido

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Respuestas
chevron-right
200

Sucesso

application/json
idstring · uuidRequerido

ID da oportunidade

created_atstring · date-timeRequerido

Data de criação

updated_atstring · date-timeRequerido

Data da última atualização

discarded_atstring · date-timeOpcional

Data que foi descartada

attributesobjectRequerido

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Example: {"Status":"Em contato","Prioridade":"Alta"}
patch
/kanban/api/v1/{component_id}/opportunities/{opportunity_id}

Estrutura das oportunidades

get

Retorna a estrutura dinâmica das oportunidades do componente.

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

Respuestas
chevron-right
200

Sucesso

application/json
get
/kanban/api/v1/{component_id}/schema

Associar contato

post

Associa a oportunidade a um determinado contato e retorna o contato associado

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

Cuerpo
idstring · uuidRequerido
Respuestas
post
/kanban/api/v1/{component_id}/opportunities/{opportunity_id}/contact

Desassociar contato

delete

Remove associação da oportunidade com o contato atual.

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

Respuestas
chevron-right
200

Successo

Sin contenido

delete
/kanban/api/v1/{component_id}/opportunities/{opportunity_id}/contact

Sin contenido

Adicionar produto

post

Adiciona um determinado produto à lista de produtos vinculados à oportunidade

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

Cuerpo
product_idstring · uuidRequerido
quantitynumberOpcional
final_pricenumberOpcional
Respuestas
post
/kanban/v1/{component_id}/opportunities/{opportunity_id}/products

Atualizar item da lista de produtos da oportunidade

put

Atualiza o item pelo ID na lista de produtos de uma determinada oportunidade

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

item_idstring · uuidRequerido

ID do item da lista de produtos

Cuerpo
product_idstring · uuidOpcional
quantitynumberOpcional
final_pricenumberOpcional
Respuestas
chevron-right
200

Sucesso

application/json

Lista de produtos de uma oportunidade

idstring · uuidOpcional

Identificação única do produto

product_namestringOpcional

Nome do produto

product_pricestring · currencyOpcional

Valor unitário do produto

quantitynumber · integerOpcional

Quantidade de produtos adicionados à oportunidade

final_pricestring · currencyOpcional

Valor final do produto

put
/kanban/v1/{component_id}/opportunities/{opportunity_id}/products/{item_id}

Remover item da lista de produtos da oportunidade

delete

Remove o item pelo ID na lista de produtos de uma determinada oportunidade

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

item_idstring · uuidRequerido

ID do item da lista de produtos

Respuestas
chevron-right
200

Sucesso

application/json

Lista de produtos de uma oportunidade

idstring · uuidOpcional

Identificação única do produto

product_namestringOpcional

Nome do produto

product_pricestring · currencyOpcional

Valor unitário do produto

quantitynumber · integerOpcional

Quantidade de produtos adicionados à oportunidade

final_pricestring · currencyOpcional

Valor final do produto

delete
/kanban/v1/{component_id}/opportunities/{opportunity_id}/products/{item_id}

Criar tarefa

post

Cria uma tarefa vinculada a uma determinada oportunidade

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

Respuestas
post
/kanban/v1/{component_id}/opportunities/{opportunity_id}/tasks

Atualizar tarefa da oportunidade

put

Atualiza a tarefa com ID na lista tarefas de uma determinada oportunidade

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

item_idstring · uuidRequerido

ID da tarefa

Respuestas
chevron-right
200

Sucesso

application/json

Lista de tarefas de uma oportunidade

idstring · uuidOpcional

Identificação única da tarefa

titlestring · uuidOpcional

Título, resumo da tarefa

descriptionstring · uuidOpcional

Descrição da tarefa

statestring · enumOpcional

Estado da tarefa

Valores posibles:
scheduled_tostring · date-timeOpcional

Data de agendamento da tarefa

Example: 2025-04-23T23:45:56.789-0300
put
/kanban/v1/{component_id}/opportunities/{opportunity_id}/tasks/{item_id}

Remover tarefa

delete

Remove uma tarefa pelo ID da lista de tarefas de uma determinada oportunidade

Autorizaciones
AuthorizationstringRequerido

Chave de API

Parámetros de ruta
component_idstring · uuidRequerido

ID do componente

opportunity_idstring · uuidRequerido

ID da oportunidade

item_idstring · uuidRequerido

ID da tarefa

Respuestas
chevron-right
200

Sucesso

application/json

Lista de tarefas de uma oportunidade

idstring · uuidOpcional

Identificação única da tarefa

titlestring · uuidOpcional

Título, resumo da tarefa

descriptionstring · uuidOpcional

Descrição da tarefa

statestring · enumOpcional

Estado da tarefa

Valores posibles:
scheduled_tostring · date-timeOpcional

Data de agendamento da tarefa

Example: 2025-04-23T23:45:56.789-0300
delete
/kanban/v1/{component_id}/opportunities/{opportunity_id}/tasks/{item_id}

Última actualización