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!
Retorna uma lista de oportunidades para um dado componente.
ID do componente
número da página
número máximo de items na página (máx. 100)
Sucesso
Chave de API inválida/ausente
Usuário sem autorização
GET /kanban/api/v1/{component_id}/opportunities HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-10-28T12:14:02.043Z",
"updated_at": "2025-10-28T12:14:02.043Z",
"discarded_at": "2025-10-28T12:14:02.043Z",
"attributes": {
"Status": "Em contato",
"Prioridade": "Alta"
}
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 1
}
}Cria uma oportunidade em um componente.
ID do componente
Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]
Sucesso
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
Erro ao processar os dados
POST /kanban/api/v1/{component_id}/opportunities HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 107
{
"attributes": {
"Status": "Em contato",
"Contato": "627a981e-060f-4e55-a3a3-1abaea0759c7",
"Prioridade": "Alta"
}
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-10-28T12:14:02.043Z",
"updated_at": "2025-10-28T12:14:02.043Z",
"discarded_at": "2025-10-28T12:14:02.043Z",
"attributes": {
"Status": "Em contato",
"Prioridade": "Alta"
}
}Retorna os dados de uma oportunidade de um componente.
ID do componente
ID da oportunidade
Sucesso
Chave de API inválida/ausente
Usuário sem autorização
GET /kanban/api/v1/{component_id}/opportunities/{opportunity_id} HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-10-28T12:14:02.043Z",
"updated_at": "2025-10-28T12:14:02.043Z",
"discarded_at": "2025-10-28T12:14:02.043Z",
"attributes": {
"Status": "Em contato",
"Prioridade": "Alta"
}
}Excluir uma oportunidade de um determinado componente. A oportunidade não pode ser visualizada, modificada ou recuperada ao ser excluída!
ID do componente
ID da oportunidade
Sucesso
Chave de API inválida/ausente
Usuário sem autorização
DELETE /kanban/api/v1/{component_id}/opportunities/{opportunity_id} HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-10-28T12:14:02.043Z",
"updated_at": "2025-10-28T12:14:02.043Z",
"discarded_at": "2025-10-28T12:14:02.043Z",
"attributes": {
"Status": "Em contato",
"Prioridade": "Alta"
}
}Atualiza os dados de uma oportunindade de um componente. Afeta somente atributos que estão no corpo da requisição.
ID do componente
ID da oportunidade
Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]
Sucesso
Erro no formato dos dados da requisição.
Chave de API inválida/ausente
Usuário sem autorização
Erro ao processar os dados
PATCH /kanban/api/v1/{component_id}/opportunities/{opportunity_id} HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"attributes": {
"Status": "Apresentação",
"Prioridade": "Alta"
}
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-10-28T12:14:02.043Z",
"updated_at": "2025-10-28T12:14:02.043Z",
"discarded_at": "2025-10-28T12:14:02.043Z",
"attributes": {
"Status": "Em contato",
"Prioridade": "Alta"
}
}Retorna a estrutura dinâmica das oportunidades do componente.
ID do componente
Sucesso
Chave de API inválida/ausente
Usuário sem autorização
GET /kanban/api/v1/{component_id}/schema HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"attributes": [
{
"id": "c8f474d1-fbce-4270-98cb-aa5ea6cc3551",
"name": "Status",
"content_type": "status",
"visibility": "show",
"available_values": [
"Novo contato",
"Em contato",
"Apresentação",
"Negociação",
"Fechamento",
"A contatar no futuro",
"Perdido",
"Ganho"
]
},
{
"id": "3763e13a-0273-401c-9c16-b7afa9aef134",
"name": "Contato",
"content_type": "contact",
"visibility": "hide"
},
{
"id": "3c80d598-9b68-4115-89cf-db82d268078a",
"name": "Prioridade",
"content_type": "string",
"visibility": "show",
"available_values": [
"Alta",
"Média",
"Baixa"
]
}
]
}Associa a oportunidade a um determinado contato e retorna o contato associado
ID do componente
ID da oportunidade
Sucesso
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
Erro ao processar os dados
POST /kanban/api/v1/{component_id}/opportunities/{opportunity_id}/contact HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"id": "7e5b359d-f4d8-48d0-b12b-e3769817576b"
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-10-28T12:14:02.043Z",
"updated_at": "2025-10-28T12:14:02.043Z",
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Smith",
"email": "john@smith.com"
},
"attributes": {
"Nome": "John Doe",
"E-mail": "john@doe.com",
"Telefone": "5511999999999"
}
}Remove associação da oportunidade com o contato atual.
ID do componente
ID da oportunidade
Successo
Sem conteúdo
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
DELETE /kanban/api/v1/{component_id}/opportunities/{opportunity_id}/contact HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Sem conteúdo
Adiciona um determinado produto à lista de produtos vinculados à oportunidade
ID do componente
ID da oportunidade
Sucesso
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
Erro ao processar os dados
POST /kanban/v1/{component_id}/opportunities/{opportunity_id}/products HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"product_id": "7e5b359d-f4d8-48d0-b12b-e3769817576b",
"quantity": 3,
"final_price": 123.45
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-10-28T12:14:02.043Z",
"updated_at": "2025-10-28T12:14:02.043Z",
"created_by": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Smith",
"email": "john@smith.com"
},
"attributes": {
"Nome": "John Doe",
"E-mail": "john@doe.com",
"Telefone": "5511999999999"
}
}Atualiza o item pelo ID na lista de produtos de uma determinada oportunidade
ID do componente
ID da oportunidade
ID do item da lista de produtos
Sucesso
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
Erro ao processar os dados
PUT /kanban/v1/{component_id}/opportunities/{opportunity_id}/products/{item_id} HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"product_id": "7e5b359d-f4d8-48d0-b12b-e3769817576b",
"quantity": 3,
"final_price": 123.45
}[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"product_name": "text",
"product_price": "text",
"quantity": 1,
"final_price": "text"
}
]Remove o item pelo ID na lista de produtos de uma determinada oportunidade
ID do componente
ID da oportunidade
ID do item da lista de produtos
Sucesso
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
Erro ao processar os dados
DELETE /kanban/v1/{component_id}/opportunities/{opportunity_id}/products/{item_id} HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"product_name": "text",
"product_price": "text",
"quantity": 1,
"final_price": "text"
}
]Cria uma tarefa vinculada a uma determinada oportunidade
ID do componente
ID da oportunidade
Sucesso
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
POST /kanban/v1/{component_id}/opportunities/{opportunity_id}/tasks HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"title": "123e4567-e89b-12d3-a456-426614174000",
"description": "123e4567-e89b-12d3-a456-426614174000",
"state": "to_do",
"scheduled_to": "2025-04-23T23:45:56.789-0300"
}
]Atualiza a tarefa com ID na lista tarefas de uma determinada oportunidade
ID do componente
ID da oportunidade
ID da tarefa
Sucesso
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
Erro ao processar os dados
PUT /kanban/v1/{component_id}/opportunities/{opportunity_id}/tasks/{item_id} HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"title": "123e4567-e89b-12d3-a456-426614174000",
"description": "123e4567-e89b-12d3-a456-426614174000",
"state": "to_do",
"scheduled_to": "2025-04-23T23:45:56.789-0300"
}
]Remove uma tarefa pelo ID da lista de tarefas de uma determinada oportunidade
ID do componente
ID da oportunidade
ID da tarefa
Sucesso
Erro no formato dos dados da requisição
Chave de API inválida/ausente
Usuário sem autorização
Erro ao processar os dados
DELETE /kanban/v1/{component_id}/opportunities/{opportunity_id}/tasks/{item_id} HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"title": "123e4567-e89b-12d3-a456-426614174000",
"description": "123e4567-e89b-12d3-a456-426614174000",
"state": "to_do",
"scheduled_to": "2025-04-23T23:45:56.789-0300"
}
]