Canopy by Copp Oak
Book local service pros from your AI assistant: real availability, instant booking, easy cancels.
Should I use this
Quality & Safety
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"canopy": {
"url": "https://canopy-mcp-production.up.railway.app/mcp/public"
}
}
}Remote endpoints
https://canopy-mcp-production.up.railway.app/mcp/publicstreamable-httphttps://mcp.coppoak.com/mcp/publicstreamable-httpWhat it can do
Tool inventory
Tools (10)
🟢canopy_check_bookable(businesses)
Given businesses you already found for the user (name plus phone, website or address with ZIP code), report which ones can be booked through Canopy and how (booking_mode). An entry that is not bookable says why (reason); needs_confirmation means use resolve_business so the user can confirm it. Results come back in exactly the order you sent them. Canopy never ranks, filters or recommends businesses. Results are returned in the same order as the input.
Input Schema
{
"type": "object",
"properties": {
"businesses": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"business_name": {
"description": "Business name as you found it. With no phone or website, add the address city, state or ZIP when known.",
"type": "string",
"maxLength": 200,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"phone": {
"description": "Business phone number.",
"type": "string",
"maxLength": 40,
"pattern": "^[0-9+().\\s-]*$"
},
"website": {
"description": "Business website URL or domain.",
"type": "string",
"maxLength": 500,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 100,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"state": {
"type": "string",
"maxLength": 50,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"zip": {
"type": "string",
"maxLength": 20,
"pattern": "^[A-Za-z0-9 -]*$"
}
},
"additionalProperties": false,
"description": "City, state and ZIP code of the business."
}
},
"additionalProperties": false
},
"description": "1 to 50 businesses, in your order. Results keep this order."
}
},
"required": [
"businesses"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}🟢resolve_business(business_name, phone, website, address)
Match one business the user named to its Canopy listing, by phone, website, or name (add the city, state or ZIP code when you know it). Returns at most one match, with its booking_mode and locations, or found=false. When a name alone is not certain, found=false comes with up to 5 candidates in alphabetical order for the user to choose from.
Input Schema
{
"type": "object",
"properties": {
"business_name": {
"description": "Business name as you found it. With no phone or website, add the address city, state or ZIP when known.",
"type": "string",
"maxLength": 200,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"phone": {
"description": "Business phone number.",
"type": "string",
"maxLength": 40,
"pattern": "^[0-9+().\\s-]*$"
},
"website": {
"description": "Business website URL or domain.",
"type": "string",
"maxLength": 500,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 100,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"state": {
"type": "string",
"maxLength": 50,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"zip": {
"type": "string",
"maxLength": 20,
"pattern": "^[A-Za-z0-9 -]*$"
}
},
"additionalProperties": false,
"description": "City, state and ZIP code of the business."
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}🟢get_availability(operator_id, location_id, customer_zip, service_id, from_date, ...)
List open appointment slots for a Canopy business, optionally for one service and one location, between two dates. Slots are cached from the business calendar (see synced_at); the time is re-checked live when you book.
Input Schema
{
"type": "object",
"properties": {
"operator_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "operator_id from canopy_check_bookable or resolve_business."
},
"location_id": {
"description": "Location for multi-location businesses.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"customer_zip": {
"description": "Customer's ZIP code, if known. For a business with several locations, Canopy uses the location nearest to it unless location_id (or a slot or service tied to one location) decides. The result names the location used.",
"type": "string",
"maxLength": 10,
"pattern": "^\\d{5}(-?\\d{4})?$"
},
"service_id": {
"description": "Only slots for this service.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"from_date": {
"description": "First day, YYYY-MM-DD. Default: today.",
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"to_date": {
"description": "Last day (inclusive), YYYY-MM-DD, at most 31 days after from_date. Default: 13 days after from_date.",
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"timezone": {
"default": "America/New_York",
"description": "IANA time zone for dates and returned times.",
"type": "string",
"maxLength": 64,
"pattern": "^[A-Za-z][A-Za-z0-9_+-]*(\\/[A-Za-z0-9_+-]+){0,2}$"
}
},
"required": [
"operator_id"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}🟢request_booking(operator_id, location_id, customer_zip, customer, notes, ...)
Start a booking with a Canopy-connected business. Canopy automatically routes to the correct flow based on the operator's booking mode: auto-confirm (booked right away in the business's calendar; the customer is emailed a confirmation), request-times (propose preferred times), or submission-only (callback request). Summarize the booking and get the customer's go-ahead before calling.
Input Schema
{
"type": "object",
"properties": {
"operator_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "operator_id from canopy_check_bookable or resolve_business."
},
"location_id": {
"description": "Location for multi-location businesses.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"customer_zip": {
"description": "Customer's ZIP code, if known. For a business with several locations, Canopy uses the location nearest to it unless location_id (or a slot or service tied to one location) decides. The result names the location used.",
"type": "string",
"maxLength": 10,
"pattern": "^\\d{5}(-?\\d{4})?$"
},
"customer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "Customer's full name."
},
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Customer's email address. Mode 1 sends the confirmation code here."
},
"phone": {
"description": "Customer's phone number.",
"type": "string",
"maxLength": 40,
"pattern": "^\\+?[0-9 ().-]{7,32}$"
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"maxLength": 200,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "Street address, e.g. \"605 E Main Street, Apt 2\"."
},
"city": {
"type": "string",
"maxLength": 100,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "City."
},
"state": {
"type": "string",
"maxLength": 50,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "State, e.g. \"VA\"."
},
"zip": {
"type": "string",
"maxLength": 10,
"pattern": "^\\d{5}(-?\\d{4})?$",
"description": "ZIP code."
}
},
"required": [
"street",
"city",
"state",
"zip"
],
"additionalProperties": false,
"description": "Where the work will be done. Ask the customer for it whenever the visit is at their home or business: some businesses' scheduling systems cannot book a job without it."
},
"notes": {
"description": "What the customer needs, in their words.",
"type": "string",
"maxLength": 2000,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
}
},
"required": [
"name",
"email"
],
"additionalProperties": false,
"description": "The customer the appointment or callback is for."
},
"notes": {
"description": "Extra details for the business (added to the customer notes).",
"type": "string",
"maxLength": 2000,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"idempotency_key": {
"description": "Optional. Reuse the same key when retrying so nothing is created twice. Derived automatically if omitted.",
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{8,128}$"
},
"agent_callback_url": {
"description": "Optional HTTPS URL that receives a webhook when the business responds.",
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"service_id": {
"description": "Service to book (from get_availability). Needed for instant-confirm and preferred-times businesses.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"slot_id": {
"description": "Open slot from get_availability (instant-confirm businesses).",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"preferred_times": {
"description": "1 to 3 preferred time windows (businesses that review requests).",
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"starts_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Start, ISO 8601 with UTC offset, e.g. 2026-10-20T14:00:00-04:00."
},
"ends_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "End, ISO 8601 with UTC offset."
}
},
"required": [
"starts_at",
"ends_at"
],
"additionalProperties": false
}
}
},
"required": [
"operator_id",
"customer"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}🟢propose_times(operator_id, location_id, customer_zip, customer, notes, ...)
Propose preferred times to a business that reviews booking requests. The business will approve one time (that books it; the customer is emailed a confirmation) or propose an alternative (the customer confirms it from an emailed code). Check status with get_request_status.
Input Schema
{
"type": "object",
"properties": {
"operator_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "operator_id from canopy_check_bookable or resolve_business."
},
"location_id": {
"description": "Location for multi-location businesses.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"customer_zip": {
"description": "Customer's ZIP code, if known. For a business with several locations, Canopy uses the location nearest to it unless location_id (or a slot or service tied to one location) decides. The result names the location used.",
"type": "string",
"maxLength": 10,
"pattern": "^\\d{5}(-?\\d{4})?$"
},
"customer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "Customer's full name."
},
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Customer's email address. Mode 1 sends the confirmation code here."
},
"phone": {
"description": "Customer's phone number.",
"type": "string",
"maxLength": 40,
"pattern": "^\\+?[0-9 ().-]{7,32}$"
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"maxLength": 200,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "Street address, e.g. \"605 E Main Street, Apt 2\"."
},
"city": {
"type": "string",
"maxLength": 100,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "City."
},
"state": {
"type": "string",
"maxLength": 50,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "State, e.g. \"VA\"."
},
"zip": {
"type": "string",
"maxLength": 10,
"pattern": "^\\d{5}(-?\\d{4})?$",
"description": "ZIP code."
}
},
"required": [
"street",
"city",
"state",
"zip"
],
"additionalProperties": false,
"description": "Where the work will be done. Ask the customer for it whenever the visit is at their home or business: some businesses' scheduling systems cannot book a job without it."
},
"notes": {
"description": "What the customer needs, in their words.",
"type": "string",
"maxLength": 2000,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
}
},
"required": [
"name",
"email"
],
"additionalProperties": false,
"description": "The customer the appointment or callback is for."
},
"notes": {
"description": "Extra details for the business (added to the customer notes).",
"type": "string",
"maxLength": 2000,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"idempotency_key": {
"description": "Optional. Reuse the same key when retrying so nothing is created twice. Derived automatically if omitted.",
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{8,128}$"
},
"agent_callback_url": {
"description": "Optional HTTPS URL that receives a webhook when the business responds.",
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"service_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Service the customer wants (from get_availability)."
},
"preferred_times": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"starts_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Start, ISO 8601 with UTC offset, e.g. 2026-10-20T14:00:00-04:00."
},
"ends_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "End, ISO 8601 with UTC offset."
}
},
"required": [
"starts_at",
"ends_at"
],
"additionalProperties": false
},
"description": "1 to 3 preferred time windows, in order of preference."
}
},
"required": [
"operator_id",
"customer",
"service_id",
"preferred_times"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}⚪request_callback(operator_id, location_id, customer_zip, customer, notes, ...)
Request a callback from a business. They will contact the customer directly. No calendar booking is created.
Input Schema
{
"type": "object",
"properties": {
"operator_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "operator_id from canopy_check_bookable or resolve_business."
},
"location_id": {
"description": "Location for multi-location businesses.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"customer_zip": {
"description": "Customer's ZIP code, if known. For a business with several locations, Canopy uses the location nearest to it unless location_id (or a slot or service tied to one location) decides. The result names the location used.",
"type": "string",
"maxLength": 10,
"pattern": "^\\d{5}(-?\\d{4})?$"
},
"customer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "Customer's full name."
},
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Customer's email address. Mode 1 sends the confirmation code here."
},
"phone": {
"description": "Customer's phone number.",
"type": "string",
"maxLength": 40,
"pattern": "^\\+?[0-9 ().-]{7,32}$"
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"maxLength": 200,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "Street address, e.g. \"605 E Main Street, Apt 2\"."
},
"city": {
"type": "string",
"maxLength": 100,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "City."
},
"state": {
"type": "string",
"maxLength": 50,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$",
"description": "State, e.g. \"VA\"."
},
"zip": {
"type": "string",
"maxLength": 10,
"pattern": "^\\d{5}(-?\\d{4})?$",
"description": "ZIP code."
}
},
"required": [
"street",
"city",
"state",
"zip"
],
"additionalProperties": false,
"description": "Where the work will be done. Ask the customer for it whenever the visit is at their home or business: some businesses' scheduling systems cannot book a job without it."
},
"notes": {
"description": "What the customer needs, in their words.",
"type": "string",
"maxLength": 2000,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
}
},
"required": [
"name",
"email"
],
"additionalProperties": false,
"description": "The customer the appointment or callback is for."
},
"notes": {
"description": "Extra details for the business (added to the customer notes).",
"type": "string",
"maxLength": 2000,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
},
"idempotency_key": {
"description": "Optional. Reuse the same key when retrying so nothing is created twice. Derived automatically if omitted.",
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{8,128}$"
},
"agent_callback_url": {
"description": "Optional HTTPS URL that receives a webhook when the business responds.",
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"service_id": {
"description": "Service the customer is asking about, if known.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"operator_id",
"customer"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}🟢get_request_status(request_id, manage_token)
Check the status of a booking request (preferred times or callback). Returns pending, approved, rejected, counter_proposed, expired, or converted. Needs the manage_token that came back when the request was made.
Input Schema
{
"type": "object",
"properties": {
"request_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "request_id returned by request_booking, propose_times or request_callback."
},
"manage_token": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{32}$",
"description": "manage_token returned with that request_id when the request was created."
}
},
"required": [
"request_id",
"manage_token"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}🟢reschedule_booking(booking_id, manage_token, slot_id, reason)
Ask to move a booking the customer already confirmed (booked with the business) to another open slot of the same service and location (slot_id from get_availability). Nothing moves right away: Canopy emails the customer a link to approve the new time, and the business calendar changes only after they approve. A hold the customer has not confirmed yet cannot be moved. Calling again with the same slot_id reports whether it was approved. Needs the manage_token that came back with the booking_id.
Input Schema
{
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "booking_id of the confirmed booking to move (from request_booking or get_request_status)."
},
"manage_token": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{32}$",
"description": "manage_token returned with that booking_id (by request_booking when the booking was created, or as booking_manage_token by get_request_status)."
},
"slot_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The new open slot (from get_availability, same service and location). The customer must approve the move by email."
},
"reason": {
"description": "Short reason for the move, if the customer gave one.",
"type": "string",
"maxLength": 500,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
}
},
"required": [
"booking_id",
"manage_token",
"slot_id"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}🔴cancel_booking(booking_id, manage_token, reason)
Cancel a booking made through Canopy. The appointment is called off in the business's calendar right away and the customer is emailed. This cannot be undone: confirm with the customer before calling. An appointment that has already started cannot be cancelled here. Needs the manage_token that came back with the booking_id.
Input Schema
{
"type": "object",
"properties": {
"booking_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "booking_id of the booking to cancel (from request_booking or get_request_status)."
},
"manage_token": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{32}$",
"description": "manage_token returned with that booking_id (by request_booking when the booking was created, or as booking_manage_token by get_request_status)."
},
"reason": {
"description": "Short reason for cancelling, if the customer gave one.",
"type": "string",
"maxLength": 500,
"pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]*$"
}
},
"required": [
"booking_id",
"manage_token"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}🟢get_business_terms(operator_id)
Get the prices of a Canopy business's bookable services, its fees and its cancellation terms, exactly as the business has them on file. Anything the business has not put on file comes back as on_file=false: tell the customer it is not on file (they can ask the business) and never estimate or fill in a value.
Input Schema
{
"type": "object",
"properties": {
"operator_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "operator_id from canopy_check_bookable or resolve_business."
}
},
"required": [
"operator_id"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Community
Evidence