Skip to main content
PUT
Atualização de oportunidade

Authorizations

Authorization
string
header
required

Utilize o token de integração no header Authorization: Bearer {token}. O domínio de origem (Origin/Referer) deve respeitar allowed_domain, quando configurado na chave.

Path Parameters

id
string
required

UUID da oportunidade a ser atualizada.

Body

application/json
title
string
required
Maximum string length: 150
stage_id
string<uuid>
responsible_id
string<uuid>
quality_rating
enum<integer>
Available options:
1,
2,
3,
4,
5
quality_reason
string
value
number
expected_close_date
string<date-time> | null
visibility
enum<integer>

0 = privado (responsável e supervisores), 1 = equipe/responsável, 2 = público.

Available options:
0,
1,
2
temperature
enum<integer>

1 = frio, 2 = morno, 3 = quente.

Available options:
1,
2,
3
persons_id
object[]

Lista de operações de associação ou remoção de participantes. delete: true remove a pessoa da oportunidade; omita ou envie false para adicionar.

person
object

Pessoa associada à oportunidade. Envie telefone, e-mail e redes sociais em contacts; phone e email no topo da oportunidade não fazem parte do contrato.

primary_person_id
string<uuid>
organization_id
string<uuid> | null
organization
object
custom_fields
object[]
marketing
object

Rastreio de marketing. Todos os valores são sanitizados (trim) e campos vazios são ignorados. utm_* são normalizados para wegly_* equivalentes quando estes não forem enviados. utm_term vira utm_search_term se o campo específico não for enviado. url_conversion tem seus parâmetros extraídos automaticamente (wegly_, utm_, gclid, fbclid, conversion_tool_name). Quando wegly_code referencia um tracker válido, a origem do lead é extraída do tracker. Quando não há tracker nem origem explícita, wegly_source ou utm_source busca/cria a origem automaticamente.

crm_lead_source_id
string<uuid>
crm_loss_reason_id
string
lost_reason_description
string
status
enum<integer>

1 = aberta, 2 = ganha, 3 = perdida.

Available options:
1,
2,
3
won_date
string<date-time>
lost_date
string<date-time>
tags
string[]

Response

Oportunidade atualizada.

Retorno enxuto da atualização de oportunidade.

id
string
code
integer
title
string
quality_rating
integer | null
quality_reason
string | null
status
enum<integer>

1 = aberta, 2 = ganha, 3 = perdida.

Available options:
1,
2,
3
lost_reason_description
string | null