Criação de oportunidades

curl --request POST \
  --url https://api.wegly.com.br/integrations/external/deals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Implementação completa CRM",
  "value": 75000.5,
  "expected_close_date": "2024-03-15T00:00:00.000Z",
  "quality_rating": 4,
  "quality_reason": "Cliente com budget aprovado",
  "visibility": 0,
  "temperature": 3,
  "crm_lead_source_id": "a6e77b5f-4d66-4e78-b15f-c0e8a16db962",
  "marketing": {
    "url_conversion": "https://landing.wegly.com.br/obrigado?wegly_code=OPP123&utm_campaign=crm-enterprise&gclid=XYZ"
  },
  "tags": [
    "enterprise",
    "crm"
  ],
  "person": {
    "name": "Roberto Martins",
    "contacts": [
      {
        "type": 0,
        "value": "+55 11 99988-7766"
      }
    ],
    "avoid_duplicate": true,
    "duplicate_check_types": [
      0
    ]
  },
  "organization": {
    "name": "Tech Innovators S.A."
  },
  "followers": [
    {
      "user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "role_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012"
    }
  ],
  "note": {
    "content": "Oportunidade originada da campanha enterprise.",
    "is_pinned": true
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": 123,
  "title": "<string>"
}

Oportunidades

Criação de oportunidades

Cria uma oportunidade (deal) usando a chave de integração, aplicando as mesmas validações internas: estágio/responsável padrão quando omitidos, conflito proibido entre organization_id e organization, origem manual aceita apenas por crm_lead_source_id (lead_source não é suportado), deduplicação de pessoa quando avoid_duplicate e duplicate_check_types forem enviados, rastreio de marketing com prioridade para wegly_code, fallback de origem por wegly_source/utm_source e extração automática de parâmetros da url_conversion, criação de ferramenta de conversão quando necessário e registro opcional de nota inicial/seguidores.

POST

integrations

external

deals

Criação de oportunidades

curl --request POST \
  --url https://api.wegly.com.br/integrations/external/deals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Implementação completa CRM",
  "value": 75000.5,
  "expected_close_date": "2024-03-15T00:00:00.000Z",
  "quality_rating": 4,
  "quality_reason": "Cliente com budget aprovado",
  "visibility": 0,
  "temperature": 3,
  "crm_lead_source_id": "a6e77b5f-4d66-4e78-b15f-c0e8a16db962",
  "marketing": {
    "url_conversion": "https://landing.wegly.com.br/obrigado?wegly_code=OPP123&utm_campaign=crm-enterprise&gclid=XYZ"
  },
  "tags": [
    "enterprise",
    "crm"
  ],
  "person": {
    "name": "Roberto Martins",
    "contacts": [
      {
        "type": 0,
        "value": "+55 11 99988-7766"
      }
    ],
    "avoid_duplicate": true,
    "duplicate_check_types": [
      0
    ]
  },
  "organization": {
    "name": "Tech Innovators S.A."
  },
  "followers": [
    {
      "user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "role_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012"
    }
  ],
  "note": {
    "content": "Oportunidade originada da campanha enterprise.",
    "is_pinned": true
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": 123,
  "title": "<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.

Body

application/json

title

string

required

Maximum string length: 150

stage_id

string<uuid>

Etapa do funil de oportunidades. Caso omitido, usa a primeira etapa do funil primário.

responsible_id

string<uuid>

Responsável pela oportunidade. Padrão: criador da chave.

quality_rating

enum<integer>

Available options:

1,

2,

3,

4,

5

quality_reason

string

Motivo da qualificação; obrigatório se o funil exigir.

value

number

Valor monetário com até 2 casas decimais.

expected_close_date

string<date-time>

Data prevista de fechamento.

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

tags

string[]

Lista de IDs de tags existentes. IDs inexistentes resultam em erro.

persons_id

object[]

IDs de pessoas já cadastradas que serão associadas.

Show child attributes

person

object

Show child attributes

primary_person_id

string<uuid>

Define o participante principal quando múltiplas pessoas são associadas.

organization_id

string<uuid>

Organização existente. Conflita com organization.

organization

object

Show child attributes

custom_fields

object[]

Show child attributes

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. Quando não há tracker nem origem explícita, wegly_source ou utm_source busca/cria a origem automaticamente.

Show child attributes

crm_lead_source_id

string<uuid>

Origem existente. Única forma aceita para informar origem manual nesta API.

followers

object[]

Seguidores adicionados após a criação da oportunidade. Usuários duplicados na lista são ignorados.

Show child attributes

note

object

Show child attributes

Response

Oportunidade criada com sucesso.

Retorno da criação de oportunidade.

string<uuid>

code

integer

Código sequencial interno da oportunidade.

title

string

Listagem de oportunidades Consulta de oportunidade