Oportunidade - Atualização de campos do registro.

Método e URL

PATCH https://api.agilize.app/crm/lead/lead/{_id}

Autenticação

Envie a chave de API no cabeçalho da requisição.

Accept: application/json
x-api-key: SUA_CHAVE_API

Parâmetros

Nome	Origem	Obrigatório	Tipo	Descrição
x-api-key	header	Sim	string	Chave da API de integração gerada em seu painel gerencial.
_id	path	Sim	integer	ID of Oportunidade to update
content-type	header	Sim	string	application/json

Corpo da requisição

Obrigatório: Sim
Content-Type: application/json

Campos do corpo

Campo	Tipo	Obrigatório	Descrição
contacts	string	Não
automations	string	Não
companies	string	Não
phones	object	Não
emails	object	Não
socials	object	Não
name	string	Não	Nome descritivo
user	string	Não
createdBy	string	Não
import	string	Não	Id da importação, caso tenha sido importado
note	string	Não	Observação associada ao lead
stage	string	Sim	Estágio atual do lead no funil
funnel	string	Sim	Funil atual do lead
source	string	Não	Id de origem do lead
archiveReason	string	Não	Motivo do arquivamento
ticket	number	Não	Ticket/valor estimado desse lead
score	number	Não	Score / Temperatura
tags	string	Não
_	object	Não
fidx1	string	Não
fidx2	string	Não
fidx3	string	Não
dtStage	string (date-time)	Não	Data da última atualização de KPIs (Uso interno)
dueDt	string (date-time)	Não	Data de previsão de fechamento do lead
tlFinishedTasks	number	Não
tlTimeline	number	Não
pendTasks	object	Não
tlPendTasks	number	Não	Total de tarefas pendentes relacionadas ao lead
dtPendTask	string (date-time)	Não	Data da tarefa pendente mais próxima
createdAt	string (date-time)	Não
system_source	string	Não	Canal/sistema que criou o lead no CRM. Exemplos: whatsapp, calendly, webhook, facebook_lead_ads, crm_automation. Não confundir com utm.provider, que representa a origem de marketing.
utm	object	Não
utmClick	object	Não
transmissionList	string	Não
ip_source	string	Não	IP de origem do lead quando conhecido. Útil para matching técnico e integrações de conversão; não é um campo analítico principal.
updatedAt	string (date-time)	Não

Estruturas internas

phones

[
  {
    "phone": "string",
    "itemType": "number"
  }
]

emails

[
  {
    "email": "string",
    "itemType": "number"
  }
]

socials

[
  {
    "link": "string",
    "itemType": "number"
  }
]

pendTasks

[
  {
    "dt": "string (date-time)"
  }
]

utm

{
  "provider": "string",
  "source": "string",
  "medium": "string",
  "clickId": "string",
  "campaignId": "string",
  "campaign": "string",
  "groupId": "string",
  "group": "string",
  "creativeId": "string",
  "creative": "string",
  "content": "string",
  "term": "string",
  "url": "string",
  "ref": "string"
}

utmClick

{
  "fbclid": "string",
  "ctwaClid": "string",
  "gclid": "string",
  "gbraid": "string",
  "wbraid": "string",
  "ttclid": "string"
}

Exemplo básico:

{
  "stage": "SUBSTITUA_PELO_ID_DA_ETAPA",
  "funnel": "SUBSTITUA_PELO_ID_DO_FUNIL",
  "name": "Lead de teste",
  "emails": [
    {
      "email": "lead.teste@exemplo.com"
    }
  ],
  "phones": [
    {
      "phone": "+5511999999999"
    }
  ]
}

Respostas

Status	Descrição	Conteúdo
200	success	application/json
401	not authenticated
404	not found
500	general error

Testar requisição

Preencha os parâmetros, informe a chave no cabeçalho x-api-key e envie a requisição diretamente pelo navegador.

Carregando teste interativo do endpoint...

PATCH`/crm/lead/lead/{_id}`