KOkommo

Atualizando um Lead

Este método permite atualizar um único lead. Passe um objeto para atualizar um único lead.

patch/api/v4/leads/{id}

Request

  • Base URL
    https://subdomain.kommo.com
  • URL
    https://subdomain.kommo.com/api/v4/leads/{id}
  • Auth
    OAuth 2

Path parameters

idinteger required

ID do Lead

Request body

namestring

Nome do Lead

pricenumber

Venda do Lead

status_idinteger

ID da Etapa à qual o Lead foi adicionado, sendo a primeira etapa do pipeline principal a padrão

pipeline_idinteger

ID do Pipeline ao qual o Lead foi adicionado

created_bystring

O ID do usuário que cria o Lead. Ao passar o valor 0, o lead será considerado como criado pelo robô.

updated_byinteger

O ID do usuário que atualiza o Lead. Ao passar o valor 0, o lead será considerado como atualizado pelo robô.

created_atinteger

A data e hora em que o lead foi criado no formato de Unix Timestamp

updated_atinteger

A data e hora em que o lead foi atualizado no formato de Unix Timestamp

closed_atinteger

A data e hora em que o lead foi fechado no formato de Unix Timestamp

loss_reason_idinteger

ID da razão da perda

responsible_user_idinteger

ID do usuário responsável pelo Lead

custom_fields_valuesstring json

Um array contendo informações sobre os valores dos campos personalizados especificados para este Lead

request_idstring

Campo que será retornado inalterado na resposta e não será salvo.

Response

200

Example response

{
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/leads"
    }
  },
  "_embedded": {
    "leads": [
      {
        "id": 152464,
        "updated_at": 1686732474,
        "_links": {
          "self": {
            "href": "https://devteam.kommo.com/api/v4/leads/152464"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.