Skip to main content
POST
Create a lead

Updating Lead Custom Attributes

To update attributes for a lead, include an attributes object in the request body. Each key in the attributes object represents an attribute ID, and its corresponding value is the new value for that attribute. provider a wrong value for an attribute will result in an error response. Example:

Authorizations

X-API-KEY
string
header
required

Body

application/json
id
string
company
string | null
company_role
string | null
phone
first_name
string | null
linkedin_url
string | null
linkedin_company_url
string | null
facebook_username
string
telegram_username
string
whatsapp_username
string
youtube_username
string
instagram_username
string
twitter_name
string | null
twitter_company_name
string | null
city
string | null
last_name
string | null
email
string | null
is_company
boolean
default:false
is_contract
boolean
default:false
create_company_if_not_exists
boolean
default:true
avatar_url
string | null
website_url
string | null
lists
status
tags
owners
contract_currency
enum<string>
Available options:
USD,
EUR,
JPY,
GBP,
AUD,
CAD,
CHF,
CNY,
HKD,
NZD,
INR,
PLN
contract_name
string | null
contract_value
id_list
string
attributes
object
icebreaker
string | null
icebreaker_2
string | null
icebreaker_3
string | null
icebreaker_4
string | null
is_draft
boolean
default:false
auto_assign_owner
boolean
default:true

Auto assign the owner to the current user

company_avatar_url
string | null
company_linkedin_url
string | null

Response

Successful response

id
string<uuid>
required
email
string | null
required
company
string | null
required
phone
string | null
required
linkedin_url
string | null
required
linkedin_company_url
string | null
required
facebook_username
string | null
required
youtube_username
string | null
required
instagram_username
string | null
required
telegram_username
string | null
required
whatsapp_username
string | null
required
search_query
string | null
required
created_at
string
required
updated_at
string | null
required
first_name
string | null
required
icebreaker
string | null
required
last_name
string | null
required
website_url
string | null
required
timezone
string | null
required
city
string | null
required
company_role
string | null
required
twitter_name
string | null
required
avatar_url
string | null
required
icebreaker_2
string | null
required
icebreaker_3
string | null
required
icebreaker_4
string | null
required
email_bounce_score
integer | null
required
twitter_company_name
string | null
required
is_company
boolean
required
is_contract
boolean
required
is_tracked
boolean | null
required
is_deleted
boolean
required
is_deleted_at
string | null
required
order
integer
required
contract_value
integer | null
required
contract_currency
string | null
required
contract_name
string | null
required
score
integer | null
required
ai_enabled
boolean
required
ai_enabled_at
string | null
required
ai_summary
string | null
required
ai_profile
string | null
required
is_draft
boolean
required
last_interaction_at
string | null
required
id_linkedin_company
string | null
required
id_linkedin
string | null
required
id_space
string | null
required
usersId
string | null
required