Update a lead

PATCH

/leads/{id}

curl --request PATCH \
  --url https://app.whatsetter.com/api/v1/leads/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "qualified", "tags": [ "example" ] }'

• Production

Update a lead’s status and/or tags from your CRM. Setting status to qualified stamps the qualification date (once). Requires scope leads:write.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

status

string

Allowed values: qualified in_progress not_interested cold pending stopped queued

tags

Array<string>

<= 20 items

Responses

200

The updated lead

Media typeapplication/json

object

data

object

id

string

phone

Digits with country code, no +

string | null

whatsapp_id

string | null

name

string | null

status

string | null

Allowed values: qualified in_progress not_interested cold pending stopped queued unknown

qualified

boolean

qualified_at

string | null format: date-time

replied

boolean

campaign_id

string | null

list_id

string | null

email

string | null

tags

Array<string>

messages_count

integer

booking_status

string | null

first_contact_at

string | null format: date-time

last_message_at

string | null format: date-time

last_message_direction

string | null

Allowed values: inbound outbound

created_at

string format: date-time

updated_at

string format: date-time

Example

{
  "data": {
    "status": "qualified",
    "last_message_direction": "inbound"
  }
}

401

Missing, unknown or revoked API key

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Resource not found in this workspace

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

422

Invalid parameter or body

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}