Technology Partnership
API Reference
Join us in Discord🇪🇸🇧🇷

Update a lead

patch
https://{subdomain}.kommo.com/api/v4/leads/

This method allows updating a single lead. Pass an object to update a single lead.

Path Params
int32
required

Lead ID

Body Params
string

Lead name

int32

Lead sale

int32

Stage ID the lead is added to, the first stage of the main pipeline by default.

int32

Pipeline ID the lead is added to.

int32

The ID of the user creating the lead. When passing the value 0, the lead will be considered as created by the robot.

int32

The ID of the user updating the lead. When passing the value 0, the lead will be considered as created by the robot.

int32

Lead creation date in the format of Unix Timestamp

int32

Lead update date in the format of Unix Timestamp

int32

Lead closure date in the format of Unix Timestamp

int32

Lead loss reason ID

int32

Lead responsible user ID

json

An array of the current lead custom fields’ values

_embedded
object

Data of the tags added to a lead

string

Field that will be returned unchanged in the response and will not be saved.

tags_to_add
array of objects

Array of tags to add. You need to pass either name or ID of the tag.

tags_to_add
tags_to_delete
array of objects

Array of tags to delete. You need to pass either name or ID of the tag.

tags_to_delete
Headers
string
Defaults to application/json
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago