Skip to main content
POST
/
v1
/
opportunities
Criar oportunidade
curl --request POST \
  --url https://api.timelyai.com.br/v1/opportunities \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "Projeto de automação",
  "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "value": 1,
  "probability": 50,
  "stage": "prospecting"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "Projeto de automação",
    "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "value": 15000,
    "probability": 50,
    "stage": "prospecting",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Chave de API para autenticação. Obtenha sua chave em https://app.timelyai.com.br/developers

Body

application/json
​
title
string
required

Título da oportunidade

Required string length: 1 - 255
Example:

"Projeto de automação"

​
lead_id
string<uuid>

ID do lead associado

​
value
number

Valor estimado da oportunidade

Required range: x >= 0
​
probability
integer

Probabilidade de fechamento (0-100%)

Required range: 0 <= x <= 100
​
stage
enum<string>

Estágio da oportunidade (padrão: prospecting)

Available options:
prospecting,
qualification,
proposal,
negotiation,
closing,
won,
lost

Response

Oportunidade criada

​
data
object