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.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

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)

Respostas

200

Sucesso

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

get

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

HTTPcURLJavaScriptPython

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-12-19T19:49:19.000Z",
      "updated_at": "2025-12-19T19:49:19.000Z",
      "discarded_at": "2025-12-19T19:49:19.000Z",
      "attributes": {
        "Status": "Em contato",
        "Prioridade": "Alta"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1
  }
}

Criação de oportunidade

post

Cria uma oportunidade em um componente.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

Corpo

application/json

attributesobjectObrigatório

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

Respostas

201

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

post

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

HTTPcURLJavaScriptPython

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-12-19T19:49:19.000Z",
  "updated_at": "2025-12-19T19:49:19.000Z",
  "discarded_at": "2025-12-19T19:49:19.000Z",
  "attributes": {
    "Status": "Em contato",
    "Prioridade": "Alta"
  }
}

Dados da oportunidade

get

Retorna os dados de uma oportunidade de um componente.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

Respostas

200

Sucesso

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

get

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

HTTPcURLJavaScriptPython

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-12-19T19:49:19.000Z",
  "updated_at": "2025-12-19T19:49:19.000Z",
  "discarded_at": "2025-12-19T19:49:19.000Z",
  "attributes": {
    "Status": "Em contato",
    "Prioridade": "Alta"
  }
}

Excluir Oportunidade

delete

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

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

Respostas

200

Sucesso

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

delete

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

HTTPcURLJavaScriptPython

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-12-19T19:49:19.000Z",
  "updated_at": "2025-12-19T19:49:19.000Z",
  "discarded_at": "2025-12-19T19:49:19.000Z",
  "attributes": {
    "Status": "Em contato",
    "Prioridade": "Alta"
  }
}

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.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

Corpo

application/json

attributesobjectObrigatório

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

Respostas

200

Sucesso

application/json

400

Erro no formato dos dados da requisição.

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

patch

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

HTTPcURLJavaScriptPython

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-12-19T19:49:19.000Z",
  "updated_at": "2025-12-19T19:49:19.000Z",
  "discarded_at": "2025-12-19T19:49:19.000Z",
  "attributes": {
    "Status": "Em contato",
    "Prioridade": "Alta"
  }
}

Estrutura das oportunidades

get

Retorna a estrutura dinâmica das oportunidades do componente.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

Respostas

200

Sucesso

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

get

/kanban/api/v1/{component_id}/schema

HTTPcURLJavaScriptPython

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"
      ]
    }
  ]
}

Associar contato

post

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

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

Corpo

application/json

idstring · uuidObrigatório

Respostas

201

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

post

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

HTTPcURLJavaScriptPython

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-12-19T19:49:19.000Z",
  "updated_at": "2025-12-19T19:49:19.000Z",
  "created_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Smith",
    "email": "[e-mail]"
  },
  "attributes": {
    "Nome": "John Doe",
    "E-mail": "[e-mail]",
    "Telefone": "5511999999999"
  }
}

Desassociar contato

delete

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

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

Respostas

200

Successo

Sem conteúdo

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /kanban/api/v1/{component_id}/opportunities/{opportunity_id}/contact HTTP/1.1
Host: /
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo

Adicionar produto

post

Adiciona um determinado produto à lista de produtos vinculados à oportunidade

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

Corpo

application/json

product_idstring · uuidObrigatório

quantitynumberOpcional

final_pricenumberOpcional

Respostas

201

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

post

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

HTTPcURLJavaScriptPython

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-12-19T19:49:19.000Z",
  "updated_at": "2025-12-19T19:49:19.000Z",
  "created_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Smith",
    "email": "[e-mail]"
  },
  "attributes": {
    "Nome": "John Doe",
    "E-mail": "[e-mail]",
    "Telefone": "5511999999999"
  }
}

Atualizar item da lista de produtos da oportunidade

put

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

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

item_idstring · uuidObrigatório

ID do item da lista de produtos

Corpo

application/json

product_idstring · uuidOpcional

quantitynumberOpcional

final_pricenumberOpcional

Respostas

200

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

put

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

HTTPcURLJavaScriptPython

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"
  }
]

Remover item da lista de produtos da oportunidade

delete

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

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

item_idstring · uuidObrigatório

ID do item da lista de produtos

Respostas

200

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

delete

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

HTTPcURLJavaScriptPython

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"
  }
]

Criar tarefa

post

Cria uma tarefa vinculada a uma determinada oportunidade

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

Respostas

201

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

post

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

HTTPcURLJavaScriptPython

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"
  }
]

Atualizar tarefa da oportunidade

put

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

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

item_idstring · uuidObrigatório

ID da tarefa

Respostas

200

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

put

/kanban/v1/{component_id}/opportunities/{opportunity_id}/tasks/{item_id}

HTTPcURLJavaScriptPython

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"
  }
]

Remover tarefa

delete

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

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

opportunity_idstring · uuidObrigatório

ID da oportunidade

item_idstring · uuidObrigatório

ID da tarefa

Respostas

200

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

delete

/kanban/v1/{component_id}/opportunities/{opportunity_id}/tasks/{item_id}

HTTPcURLJavaScriptPython

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"
  }
]