Adicionar oportunidade

post

https://api.pipe.run/v1/deals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Endpoint utilizado para adicionar uma oportunidade na conta do CRM PipeRun.

🚧
Atenção! Nosso sistema utiliza o título da oportunidade como critério para evitar duplicidade de oportunidades. Portanto, não é possível criar mais de uma oportunidade com o mesmo título via requisição à API. Caso a requisição seja realizada, a oportunidade já existente de mesmo nome será atualizada com os valores presentes na requisição.

Body Params

pipeline_id

int32

required

ID do funil da oportunidade

stage_id

int32

required

ID da etapa da oportunidade

title

string

required

Título da oportunidade

frozen_at

date

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

reference

string

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

temperature

int32

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

probability

int32

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

owner_id

int32

ID do usuário dono da oportunidade

person_id

int32

ID da pessoa vinculada à oportunidade

company_id

int32

ID da empresa vinculada à oportunidade

lost_reason_id

int32

ID do motivo de perda da oportunidade

origin_id

int32

ID da origem da oportunidade

started_in_stage_id

int32

ID da etapa onde a oportunidade foi criada

created_at

date

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

closed_at

date

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

reason_close

string

Comentário do motivo de perda.

status

int32

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

deleted

boolean

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

freezed

boolean

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

value

float

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

value_mrr

float

Valor de recorrência (MRR) da oportunidade

order

int32

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

probably_closed_at

date

Data de previsão de fechamento

last_contact_at

date

Data do último contato. Formatos aceitos: AAAA-MM-DD / AAAA-MM-DD HH:MM:SS. São considerados como último contato: nota adicionada, atividade concluída, e-mail enviado e ligação realizada.

custom_fields

array of objects

Array contendo o ID e os valores dos campos customizados da oportunidade

custom_fields

201201

404404

422422