logo
Campaign LeadsUpdate campaign lead

Update campaign lead

Update a campaign lead's status or AI tag. Status can only be changed to "active" or "paused". When aiTag is set, a lead.tag_changed webhook is triggered if the tag value actually changed. The aiTag must match an existing tag name in the workspace's AI tagging labels.

curl -X PATCH "https://api.sendkit.ai/v1/campaigns/example_string/leads/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
  "status": "paused",
  "aiTag": "Interested"
}'
{
  "success": true,
  "data": {
    "_id": "666a1b2c3d4e5f6a7b8c9d01",
    "campaignId": "665a1b2c3d4e5f6a7b8c9d0e",
    "status": "paused",
    "aiTag": "Interested",
    "currentSequenceStep": 1,
    "replied": false,
    "addedAt": "2025-06-15T09:00:00.000Z"
  }
}
PATCH
/v1/campaigns/{campaignId}/leads/{campaignLeadId}
PATCH
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
path
campaignLeadIdstring
Required

Campaign lead record ID (the _id from the CampaignLead document, not the Lead ID)

Content-Typestring
Required

The media type of the request body

Options: application/json
statusstring

New status for the campaign lead

Options: active, paused
aiTagstring

AI tag for the campaign lead. Must match an existing workspace tag name. Set to null to clear.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Path Parameters

campaignLeadIdstring
Required

Campaign lead record ID (the _id from the CampaignLead document, not the Lead ID)

Body

application/json
statusstring

New status for the campaign lead

Allowed values:activepaused
aiTagstring

AI tag for the campaign lead. Must match an existing workspace tag name. Set to null to clear.

Responses

successboolean
dataobject