PUT
/
agents
/
{agentId}
/
leads
/
{leadId}
Update Lead
curl --request PUT \
  --url https://api.chat-dash.com/v1/public/agents/{agentId}/leads/{leadId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone": "<string>",
  "customFields": {},
  "tags": [
    "<string>"
  ]
}'
{
  "_id": "<string>",
  "phone": "<string>",
  "customFields": {},
  "tags": [
    "<string>"
  ]
}

Headers

Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Path Parameters

agentId
string
required

The ID of the agent

leadId
string
required

The ID of the lead

Body

application/json
phone
string

The phone number of the lead

customFields
object

The user defined fields for the lead. Keys are field names, values are field values.

tags
string[]

The IDs of the tags attached to the lead

Response

OK

_id
string

The ID of the lead

phone
string

The phone number of the lead

customFields
object

The user defined fields for the lead. Keys are field names, values are field values.

tags
string[]

The IDs of the tags attached to the lead