v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Atualizar oportunidade

put/deals/{deal_id}

Path parameters

deal_idinteger required

ID da Oportunidade

Request body

pipeline_idinteger

ID do funil da oportunidade

stage_idinteger

ID da etapa da oportunidade

titlestring

Título da oportunidade

frozen_atstring date

Data em que a oportunidade foi congelada. Formatos aceitos: AAAA-MM-DD / AAAA-MM-DD HH:MM:SS

referencestring

Referência da oportunidade para integração com outros sistemas. Por exemplo, ID do lead no RD Station

temperatureinteger

Temperatura da oportunidade: (1= muito quente / 2= quente / 3= morna / 4= fria)

probabilityinteger

Probabilidade de fechamento da oportunidade, sendo possível informar de "0" até "90".

owner_idinteger

ID do usuário dono da oportunidade

person_idinteger

ID da pessoa vinculada à oportunidade

company_idinteger

ID da empresa vinculada à oportunidade

lost_reason_idinteger

ID do motivo de perda da oportunidade

origin_idinteger

ID da origem da oportunidade

started_in_stage_idinteger

ID da etapa onde a oportunidade foi criada

created_atstring date

Data de criação da oportunidade. Formatos aceitos: AAAA-MM-DD / AAAA-MM-DD HH:MM:SS

closed_atstring date

Data de fechamento da oportunidade. Formatos aceitos: AAAA-MM-DD / AAAA-MM-DD HH:MM:SS

reason_closestring

Comentário do motivo de perda.

statusinteger

Status da oportunidade (0= aberta / 1= ganha / 3= perdida)

deletedboolean

Oportunidade na lixeira (False= fora da lixeira / True= na lixeira)

freezedboolean

Oportunidade congelada (False= oportunidade não congelada / True= oportunidade congelada)

valuenumber float

Valor de produtos e serviços (P&S) da oportunidade

value_mrrnumber float

Valor de recorrência (MRR) da oportunidade

orderinteger

Ordem (ou posição) da oportunidade na etapa do funil

probably_closed_atstring date

Data de previsão de fechamento

last_contact_atstring date

Data do último contato. Formatos aceitos: AAAA-MM-DD / AAAA-MM-DD HH:MM:SS

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": {
    "id": 748,
    "account_id": 748,
    "hash": "tg3xr6nfxz4woc8s4cg8c84cwww0s84",
    "type_reference": 160,
    "reference": "f531d85c9b@emailtown.club",
    "temperature": 1,
    "probability": 100,
    "pipeline_id": 1,
    "owner_id": 1,
    "stage_id": 1,
    "person_id": 1,
    "company_id": 1,
    "lost_reason_id": 1,
    "origin_id": 1,
    "started_in_stage_id": 1,
    "city_id": 3826,
    "created_at": "2020-03-09",
    "title": "abc",
    "observation": "800 pessoas",
    "closed_at": "2020-03-16 22:27:42",
    "value": 100,
    "updated_at": "2020-04-09 16:51:50",
    "last_stage_updated_at": "2020-04-09 16:51:50",
    "value_mrr": 600,
    "probably_closed_at": "2020-02-28"
  }
}