Leads

Update a lead

Updates an existing lead with the provided fields. Only fields included in the request body are modified — omitted fields remain unchanged.

Use this to update contact information, venue details, event preferences, status flags (spam, archived), or reassign the lead to a different staff member.

Required permission: lead_write

put/api/v1/leads/{lead_id}

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/leads/{lead_id}
  • Auth: none declared. Required headers: Api-Key

Path parameters

lead_idinteger required

The unique ID of the lead to update

Headers

Api-Keystring required

Your Integration Key

Request body

first_namestring

Contact first name

last_namestring

Contact last name

emailstring

Contact email address

phonestring

Contact phone number

company_namestring

Business or organization name

staff_idinteger

Staff member ID requested for the lead's package

lead_sourcestring

How the lead was acquired

contact_preference'Email' | 'Phone' | 'Text Message'

How the lead prefers to be contacted

lead_typestring

Custom label for categorizing the lead

notesstring

Private internal notes about this lead

starts_at_datestring

Requested event date (YYYY-MM-DD)

starts_at_timestring

Requested event start time

length_in_minutesinteger

Requested event duration in minutes

estimated_budgetnumber

Estimated event budget

estimated_number_guestsinteger

Estimated number of guests

venue_namestring

Event venue name

venue_addressstring

Venue street address

venue_citystring

Venue city

venue_statestring

Venue state

venue_zipstring

Venue ZIP code

indoor_outdoor'Indoor' | 'Outdoor'

Venue type

service_idinteger

Service (event category) ID the lead is interested in, from GET /api/v1/event_categories. Ignored when package_id is sent: the package sets the service. Must belong to this business.

package_idinteger

Package (event type) ID the lead is interested in, from GET /api/v1/packages. Must belong to this business.

brand_idinteger

Brand ID to associate with this lead

spamboolean

Mark lead as spam

archivedboolean

Archive the lead

next_follow_up_onstring

Next follow-up date (YYYY-MM-DD)

custom_questionsobject

Responses to custom booking questions, as key-value pairs

Response

lead updated

Changes

No recorded changes to this operation across all 2 revisions of this API.