Etapa do Funil - Atualização de campos do registro.

Método e URL

PATCH https://api.agilize.app/crm/lead/stage/{_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 Etapa do Funil 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	Valores / Exemplo
funnel	string	Não
label	string	Não
systemName	string	Não
color	string	Não
isFinal	boolean	Não
finalType	string	Não	Aceita: won, loss, null
order	number	Não
transitionRules	object	Não
deleted	boolean	Não
updatedAt	string (date-time)	Não
createdAt	string (date-time)	Não

Estruturas internas

transitionRules

[
  {
    "path": "string",
    "label": "string",
    "hint": "string",
    "source": "string"
  }
]

Exemplo básico:

{
  "funnel": "valor",
  "label": "valor",
  "systemName": "valor",
  "color": "valor",
  "isFinal": true,
  "finalType": "won",
  "order": 1,
  "transitionRules": [
    {}
  ]
}

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/stage/{_id}`