Skip to main content
PUT
Update a lead

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Path Parameters

id
integer
required

The lead identifier

Body

application/json
first_name
string | null

The first name.

Maximum string length: 255
last_name
string

The last name.

Maximum string length: 255
phone_number
string | null

The phone number in E.164 format.

Maximum string length: 50
email
string<email> | null

The email address.

Maximum string length: 255
description
string | null

The description.

message
string | null

The message body.

preferred_contact
string | null

Preferred contact channel.

Maximum string length: 50
source_page_url
string<uri> | null

URL of the page that produced the lead.

Maximum string length: 2048
lead_status_id
integer | null

The lead status ID.

lead_reference_source_id
integer | null

The lead reference source ID.

assigned_user_id
integer | null

The assigned user ID.

country_id
integer | null

The country ID.

marketing_attribution
string[] | null

The marketing attribution.

Response

success
string
required
data
LeadResource · object
required