Skip to main content
PUT
/
integrations
/
external
/
deals
/
{id}
Atualização de oportunidade
curl --request PUT \
  --url https://api.wegly.com.br/integrations/external/deals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "responsible_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quality_rating": 1,
  "quality_reason": "<string>",
  "value": 123,
  "expected_close_date": "2023-11-07T05:31:56Z",
  "visibility": 0,
  "temperature": 1,
  "persons_id": [
    {
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "delete": true
    }
  ],
  "person": {
    "name": "<string>",
    "birth_date": "2023-12-25",
    "gender": 123,
    "notes": "<string>",
    "contacts": [
      {
        "type": 0,
        "value": "<string>"
      }
    ],
    "avoid_duplicate": true,
    "duplicate_check_types": [
      0
    ]
  },
  "primary_person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "organization": {
    "name": "<string>",
    "legal_name": "<string>",
    "document": "<string>",
    "industry": "<string>",
    "description": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "site": "<string>"
  },
  "custom_fields": [
    {
      "id": "<string>",
      "value": "<string>",
      "option_id": "<string>",
      "option_ids": [
        "<string>"
      ]
    }
  ],
  "marketing": {
    "wegly_code": "<string>",
    "wegly_campaign": "<string>",
    "wegly_ad_set": "<string>",
    "wegly_content": "<string>",
    "wegly_displayed_on": "<string>",
    "wegly_conversion_tool": "<string>",
    "wegly_creative": "<string>",
    "gclid": "<string>",
    "fbclid": "<string>",
    "url_conversion": "<string>",
    "utm_search_term": "<string>",
    "utm_source": "<string>",
    "utm_campaign": "<string>",
    "utm_ad_set": "<string>",
    "utm_content": "<string>",
    "utm_term": "<string>",
    "utm_display_on": "<string>"
  },
  "crm_lead_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lead_source": {
    "name": "<string>"
  },
  "crm_loss_reason_id": "<string>",
  "lost_reason_description": "<string>",
  "status": 1,
  "won_date": "2023-11-07T05:31:56Z",
  "lost_date": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "code": 123,
  "title": "<string>",
  "quality_rating": 123,
  "quality_reason": "<string>",
  "status": 1,
  "lost_reason_description": "<string>"
}

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
​
primary_person_id
string<uuid>
​
organization_id
string | null
​
organization
object
​
custom_fields
object[]
​
marketing
object

Rastreio de marketing. Todos os valores são sanetizados (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.

​
crm_lead_source_id
string<uuid>
​
lead_source
object
​
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