Skip to main content
Check Cherry logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 25
  • Triggers: 0
  • Slug: CHECK_CHERRY
  • Version: 20261101_00

Tools

Slug: CHECK_CHERRY_ATTACH_QUESTIONNAIRECopy a questionnaire template onto a proposal or confirmed booking, preserving its contents and visibility settings at attachment time. Non-admin users can attach only templates with staff viewing enabled.

Input Parameters

integer
required
Event resource ID for the proposal or confirmed booking that will receive the questionnaire, from List Events; this is not the related event_booking ID.
integer
required
Questionnaire template ID to copy, from List Questionnaire Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_CHECK_EVENT_AVAILABILITYCheck whether a package can be booked on one date or across a date range.

Input Parameters

string
Last date of the range in YYYY-MM-DD format. Required with starts_at when event_date is omitted.
string
First date of the range in YYYY-MM-DD format. Required with ends_at when event_date is omitted.
string
Single date to check in YYYY-MM-DD format. Use this alone, or omit it and provide both starts_at and ends_at.
integer
required
Package ID to check. Check Cherry requires this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_CREATE_APPOINTMENTCreate a staff appointment for a guest at a specific date, time, and duration; this changes the business calendar.

Input Parameters

integer
Staff user ID; omit to use the authenticated user.
integer
Brand ID; omit to use the primary brand.
string
Appointment location or channel, such as Phone or In Person.
string
required
Guest’s full name.
string ("quick_add" | "widget" | "app")
required
Provider channel to record for appointment creation.
string
required
Guest email address.
string
Guest phone number.
string
Internal notes not intended for the guest.
string
required
Appointment date in YYYY-MM-DD format.
string
required
Appointment start time, such as 2:00 PM.
integer
required
Appointment duration in minutes.
integer
Staff appointment calendar ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_CREATE_EXPENSERecord a business expense with its payment date, amount, reference, payee, and optional event and category links.

Input Parameters

number
required
Expense amount in the account currency.
integer
Event ID to associate with the expense.
integer
Staff member ID; required when payee_type is staff.
string
Payee name; required when payee_type is custom.
string ("custom" | "staff")
Whether the payee is a named external payee or a staff member.
string
Reason or details for the expense.
string
required
Payment date in YYYY-MM-DD format.
string
Payment method, such as Cash, Check, or Credit Card.
string
required
Unique expense reference number.
integer
Expense category ID from List Expense Categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_DELETE_APPOINTMENTSoft-delete one appointment so it no longer appears in active business calendar records; Check Cherry retains the deleted record.

Input Parameters

integer
required
Unique appointment ID to remove from active calendar records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_DELETE_EXPENSESoft-delete one business expense so it no longer appears in listings; Check Cherry retains the record for record-keeping.

Input Parameters

integer
required
Unique expense ID to remove from expense listings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_GET_APPOINTMENTReturn full guest, scheduling, and assignment details for one appointment.

Input Parameters

integer
required
Unique appointment ID, available from List Appointments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_GET_EVENTReturn event details for one proposal or booking by event ID. For proposals with alternatives, the event’s balance and deposit totals combine all alternatives and do not represent the price the client pays.

Input Parameters

integer
required
Unique event ID, available from List Events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_GET_LEADReturn full details for one lead by ID.

Input Parameters

integer
required
Unique lead ID, available from List Leads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_GET_QUESTIONNAIREReturn one questionnaire with its completion state and, for standard questionnaires, its questions and current answers. External questionnaires instead provide a link to the hosted form.

Input Parameters

integer
required
Unique questionnaire ID, available from List Questionnaires.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_GET_REPORTReturn one time-bucketed Check Cherry business report for bookings, leads, payments, proposals, or projected revenue.

Input Parameters

string
End of the report range in YYYY-MM-DD format; defaults to today.
integer
Limit the report to one brand.
string ("year" | "quarter" | "month" | "week" | "day")
Time bucket for report results.
string
Start of the report range in YYYY-MM-DD format; defaults to one year ago.
string ("created_on" | "scheduled_on")
Bucketing date for leads or proposals only. created_on uses creation date; scheduled_on uses the requested or proposed event date.
string ("bookings" | "leads" | "payments" | "proposals" | "revenue_projection")
required
Business metric to report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_APPOINTMENTSSearch staff appointments by date, assignee, brand, cancellation state, time direction, or text, returning one page.

Input Parameters

integer
Return appointments for this brand only.
string
Latest appointment date in YYYY-MM-DD format.
integer
Number of appointments to request in this page.
string
Staff member ID, or ‘my’ for the authenticated user.
string
Earliest appointment date in YYYY-MM-DD format.
string
Continuation cursor from a previous call; omit for the first page.
string
Text to search across appointment and guest details.
string ("past" | "future" | "both")
Return past, future, or both groups of appointments.
string
Check Cherry cancellation-state filter. The provider does not publish the accepted values for appointments, so use a value confirmed for the connected account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_APPOINTMENT_SLOTSReturn appointment time slots for one staff member and appointment calendar on a selected date, including each slot’s availability status.

Input Parameters

integer
required
Staff user ID whose appointment availability to inspect.
string
required
Date to inspect in YYYY-MM-DD format.
integer
required
Appointment calendar ID for the selected staff member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_EVENT_BOOKINGSList package bookings attached to events within an optional event-date range, returning one page and a continuation cursor.

Input Parameters

integer
Number of bookings to request in this page.
string
Continuation cursor from a previous call; omit for the first page.
string
Latest event date in YYYY-MM-DD format.
string
Earliest event date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_EVENTSSearch proposals and confirmed bookings with date, status, client, staff, payment, and workflow filters, returning one page; expired proposals are excluded. For proposals with alternatives, event-level balance and deposit amounts aggregate all alternatives rather than the price of one option.

Input Parameters

integer
Return events for this brand only.
boolean
When true, return only events with a past-due payment.
integer
Number of events to request in this page. No provider maximum is verified.
integer
Return events assigned to this staff member.
integer
Return events for this client only.
string
Continuation cursor from a previous call; omit for the first page.
string
Text to search across event and contact details.
string ("proposal_date_open" | "proposal_date_reserved" | "proposal_awaiting_review" | "awaiting_signature" | "confirmed" | "any_proposal" | "any_confirmed" | "any_unsigned")
Proposal or confirmed-booking status to return. Cancellation is controlled separately by canceled_status.
string
Latest event date in YYYY-MM-DD format.
string ("hide_canceled" | "show_canceled_only" | "show_all")
Cancellation filter: hide_canceled excludes canceled events, show_canceled_only returns only canceled events, and show_all includes both. Omit to use hide_canceled.
boolean
When true, return only events with an unpaid deposit.
string
Earliest event date in YYYY-MM-DD format.
string ("hide_postponed" | "show_postponed_only" | "show_all")
Postponement filter: hide_postponed excludes postponed events, show_postponed_only returns only postponed events, and show_all includes both. Omit to use hide_postponed.
boolean
When true, return only events with no staff assigned.
boolean
When true, return only events with an unsubmitted form.
boolean
When true, return only events with a balance owed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_EXPENSE_CATEGORIESReturn the expense categories available for classifying business expenses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_EXPENSESSearch business expenses by event, category, payment date, text, and sort order, returning one page.

Input Parameters

string ("paid_at_asc" | "paid_at_desc" | "relevance")
Order returned expenses.
integer
Return expenses associated with this event.
integer
Number of expenses to request in this page.
string
Continuation cursor from a previous call; omit for the first page.
string
Search expense reference numbers, payees, and descriptions.
string
Latest payment date in YYYY-MM-DD format.
string
Earliest payment date in YYYY-MM-DD format.
integer
Return expenses in this category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_LEADSList one page of leads, optionally filtering by exact email or full-text search across lead names, email, phone, venue, and notes.

Input Parameters

string
Return leads with this exact email address.
integer
Number of leads to request in this page. The provider has no verified maximum, so the default is a conservative 25.
string
Continuation cursor from a previous response; omit for the first page.
string
Search lead names, emails, phones, venues, and notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_OFFERINGSList one Check Cherry catalog resource: active services, publicly visible package groups, packages, or active add-ons.

Input Parameters

string ("services" | "package_groups" | "packages" | "add_ons")
required
Catalog resource to list.
string
Package visibility filter, such as public_only. Valid only when resource is packages.
string
Search add-ons by name. Valid only when resource is add_ons.
array
Filter add-ons by category IDs. Valid only when resource is add_ons.
boolean
Return only add-ons visible on the booking widget. Valid only when resource is add_ons.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_PAYMENTSList event payment records, including received payments and refunds, by event or payment date; returns one page with monetary values in Check Cherry’s original representations.

Input Parameters

integer
Return payments for this event only.
integer
Number of payments to request in this page. No provider maximum is verified.
string
Continuation cursor from a previous call; omit for the first page.
string
Latest payment date in YYYY-MM-DD format.
string
Earliest payment date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_QUESTIONNAIRESList questionnaires attached to one event booking. Results reflect the authenticated user’s visibility permissions and questionnaire display window.

Input Parameters

integer
required
Event resource ID for the proposal or confirmed booking whose questionnaires to return, from List Events; do not use the related event_booking ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_LIST_QUESTIONNAIRE_TEMPLATESList the business’s questionnaire templates that can be attached to an event booking. Deleted templates are excluded; non-admin users see only templates with staff viewing enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_REMOVE_QUESTIONNAIREDetach one questionnaire from its event booking and delete its collected answers; the source questionnaire template is unchanged. Requires an admin or extended-staff integration-key user in addition to event write permission.

Input Parameters

integer
required
Unique questionnaire ID to detach from the booking with its answers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_UPDATE_EXPENSEChange selected fields on an existing business expense.

Input Parameters

number
Replacement expense amount in the account currency.
integer
Replacement associated event ID.
integer
Replacement staff payee ID.
integer
required
Unique expense ID to update.
string
Replacement custom payee name.
string ("custom" | "staff")
Replacement payee type.
string
Replacement expense description.
string
Replacement payment date in YYYY-MM-DD format.
string
Replacement payment method.
string
Replacement reference number.
integer
Replacement expense category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHECK_CHERRY_UPDATE_QUESTIONNAIRE_ANSWERSUpdate answers on a standard questionnaire. By default, answers merge by field UUID, but each supplied UUID replaces that field’s complete answer array. Set replace_all to delete answers for omitted UUIDs as well. The integration-key user must be staff with edit access to the questionnaire.

Input Parameters

boolean
Whether answers_by_field_uuid represents the complete questionnaire. False merges by field UUID while replacing each supplied field’s full answer array; true also deletes answers for omitted field UUIDs.
integer
required
Unique questionnaire ID to update.
object
required
Answers keyed by field UUID from Get Questionnaire. Each value is the complete array of entries for that field; entry keys depend on the field type (for example, text_field uses text and dropdown uses dropdown). Include every element of each supplied entry; an empty array clears the field. Example: {“field-uuid”: [{“text”: “Answer”}]}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not