Skip to main content
PUT
Update Lead
Silent truncationfirstName, lastName, groups, segments are truncated to 30 characters; tags / tagsAdd to 64 characters. The API returns success with no error. Validate input length before sending.

Headers

Authorization
string
required

Bearer [access_token]

Content-Type
string
required

application/json

Path Parameters

leadId
integer<int64>
required

ID of the lead to update.

Required range: x >= 1

Body

application/json

Lead update payload.

cannotText
boolean

false: can send message to the lead

cannotCall
boolean

false: can call to the lead

cannotEmail
boolean

false: can email to the lead

firstName
string

The first/given name of the lead Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.

Example:

"Bob"

lastName
string

The last/family name of the lead Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.

Example:

"Li"

emails
string[]

A list of email addresses associated with the lead

Example:
phones
string[]

A list of phone numbers associated with the lead. (No more than 20 characters per phone)

Example:
leadTypes
integer<int32>[]

Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7),Homeowner (8), Landlord (9)

Example:
assignedUserId
integer<int64>

Id of the agent assigned to this contact

Example:

10000000514

streetAddress
string
deprecated

The streetAddress associated with the lead. Deprecated: please use the streetAddress field in property instead.

Example:

"The White House,1600 Pennsylvania Avenue NW"

city
string
deprecated

The city associated with the lead. Deprecated: please use the city field in property instead.

Example:

"Washington DC"

state
string
deprecated

The state associated with the lead. Deprecated: please use the state field in property instead.

Example:

"Washington DC"

zipCode
string
deprecated

ZipCode. Deprecated: please use the zipCode field in property instead.

Example:

"20500"

referredBy
string

The referee of the lead

Example:

"Jeremy Kelly"

isHidden
boolean

The lead is hidden or not

Example:

false

stage
string

The stage the lead is in, less than 20 characters

Example:

"Pending"

groups
string[]
deprecated

The groups the lead is in Caution: Max limit 30 characters.If you exceed the limit,the import will success , but only import 30 characters in front. deprecated, use segments instead.

Example:
segments
string[]

The segments the lead is in Caution: Max limit 30 characters.If you exceed the limit,the import will success , but only import 30 characters in front.

Example:
tags
string[]

The tags associated with the lead. All existing tags will be updated based on this call Caution: Max limit 64 characters.If you exceed the limit,the import will success , but only import 64 characters in front.

Example:
tagsAdd
string[]

The tags associated with the lead. All existing tags will be retained, only add new tags base on this call Caution: Max limit 64 characters. If you exceed the limit, the import will success, but only import 64 characters in front.

Example:
source
string

The source of the lead

Example:

"Open House"

inquiry
object

LeadInquirys

property
object

Lead property or mailing address details

customAttributeList
object[]

User customized field

birthday
string

The birthday of the lead(pattern:MMM d, yyyy)

Example:

"Jun 5, 2001"

buyingTimeFrame
string

buying time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.

Example:

"6-12"

preQual
string

Pre-qual, Yes or No.

Example:

"Yes"

houseToSell
string

House to Sell, Yes or No.

Example:

"Yes"

fthb
string

first time home buyer, Yes or No.

Example:

"Yes"

withBuyerAgent
string

With buyer Agent, Yes or No.

Example:

"Yes"

sellingTimeFrame
string

selling time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.

Example:

"1-3"

mortgage
string

Mortgage, Yes or No.

Example:

"Yes"

buyHouse
string

Buy a house, Yes or No.

Example:

"Yes"

withListingAgent
string

With listing agent, Yes or No.

Example:

"Yes"

leadFamilyMemberList
object[]

A list of family members associated with the lead. You can add up to 4 family members.

language
string

The lead's abbreviated language, en, fr, de, es, zh-CN, zh-TW, ja

Example:

"en"

ownershipId
integer<int64>

The entity ID for the ownership scope. Required when ownershipScope is OFFICE (pass the office ID) or PERSONAL (pass the agent's user ID). Ignored when ownershipScope is TEAM.

ownershipScope
string

Controls the visibility scope of the lead. TEAM — Account-wide: visible to all users in this Lofty client account. OFFICE — visible only within the specified office (requires ownershipId). PERSONAL — visible only to the specified agent (requires ownershipId). Note: TEAM refers to the entire client account (the organization), not the Lofty "Team add-on" product.

Example:

"TEAM"

unsubscription
boolean

Unsubscription the email

leadTransaction
object
tagsRemove
string[]

Tags to remove from the lead, by literal name. Only tags that are already on the lead are affected — a name not currently on the lead is ignored (so a brand-new tag introduced by tags/tagsAdd in the same request is not affected). Names are matched literally, so a tag named "*" is removed like any other. To remove ALL tags use the clearAllTags flag instead. Applied after tags/tagsAdd; it does not change their behavior. Omit it to leave tags unchanged.

Example:
clearAllTags
boolean

Set to true to remove ALL tags from the lead. Takes precedence over tags / tagsAdd / tagsRemove. Defaults to false (no change).

Example:

false

Response

Lead updated.

Response containing the lead ID.

leadId
integer<int64>

ID of the lead.

Example:

651095960136641