Leads

Add a booking to a lead

Adds a new booking (package selection) to an existing lead. Staff is requested per package, so each booking carries its own staff_id.

Required permission: lead_write

post/api/v1/leads/{lead_id}/lead_bookings

Request

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

Path parameters

lead_idinteger required

Lead ID

Headers

Api-Keystring required

Your Integration Key

Request body

event_type_idinteger

Package (event type) ID. Must belong to this business.

event_category_idinteger

Service (event category) ID. Ignored when event_type_id is sent: the package sets the service.

package_group_idinteger

Package group ID. Ignored when event_type_id is sent: the package sets the group.

starts_at_datestring

Event date (e.g. 2026-09-15)

starts_at_timestring

Event start time (e.g. 06:00 PM)

length_in_minutesinteger

Length in minutes (for time-based packages)

length_in_daysinteger

Length in days (for multi-day packages)

unitsinteger

Number of units (for per-unit packages)

package_unit_range_idinteger

Selected package unit range ID

staff_idinteger

Staff member requested for this package

Response

lead booking created

Changes

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