Skip to main content
PATCH
Update a campaign lead

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Path Parameters

id
string<uuid>
required

Campaign ID.

leadId
string<uuid>
required

Lead ID.

Body

application/json
name
string | null
phone
string

International E.164 phone number.

email
string<email> | null
tags
string[]
Maximum array length: 32
Maximum string length: 40
custom_fields
object

Flat user-managed variables. Null deletes a key; system-managed keys are rejected.

Response

Updated campaign lead.

data
object