Skip to main content
PATCH
/
api
/
campaigns
/
{id}
/
leads
Update Lead in Campaign
curl --request PATCH \
  --url https://app.puffle.ai/api/campaigns/{id}/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prospect_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updates": {
    "email": "<string>",
    "linkedin_url": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "company": "<string>",
    "position": "<string>",
    "headline": "<string>"
  }
}
'
{
  "prospect": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "email": "jsmith@example.com",
    "linkedin_url": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "company": "<string>",
    "position": "<string>",
    "headline": "<string>",
    "custom_fields": {},
    "source": "<string>",
    "source_ref": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "bounced_at": "2023-11-07T05:31:56Z",
    "replied_at": "2023-11-07T05:31:56Z",
    "current_node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
CLI:
puffle campaign lead update --id <id> --prospect-id <prospect-id> --updates <updates>

Overview

Edit a single lead’s profile fields. Draft campaigns only. Non-listed fields are ignored. Status and sequencing columns are not editable through this endpoint.
This operation shares the URL path /api/campaigns/{id}/leads with other verbs. See the sibling page for related operations on the same resource.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Campaign UUID

Body

application/json
prospect_id
string<uuid>
required
updates
object
required

Response

Lead updated successfully.

prospect
object
required

Canonical campaign lead row.