Skip to main content
Leads

Update a lead

PATCH
/leads/{id}
Authorizationstringheaderrequired

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

idstringrequired

Body

application/json
archivedboolean
emailstring | null
Required string length: 1 - 255
follow_up_datestring | null
Pattern: ^\d{4}-\d{2}-\d{2}$
namestring
Required string length: 1 - 255
phonestring | null
Required string length: 1 - 40
priorityenum<string>
Available options: low, medium, high
projected_valuenumber | null
Required range: 0 <= x <= 10000000
propertyobject | null
service_typesstring[]
Maximum array length: 20
sourcestring | null
Maximum string length: 100
stagestring
Maximum string length: 100

Response

application/json

The updated lead

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

archivedbooleanrequired
archived_atstring | nullrequired
assigned_tostring[]required
attachmentsobject[]required
created_atstringrequired
emailstring | nullrequired
follow_up_datestring | nullrequired
Pattern: ^\d{4}-\d{2}-\d{2}$
idstringrequired
namestringrequired
noteobject | nullrequired
phonestring | nullrequired
priorityenum<string> | nullrequired
Available options: low, medium, high
projected_valuenumber | nullrequired
propertyobject | nullrequired
service_typesstring[]required
sourcestring | nullrequired
stagestring | nullrequired
tagsstring[]required
updated_atstringrequired