Checkout Page

update_event

Destructive

Update an existing event page's content and settings. Supports a subset of create's fields; read current values with get_event before a partial update. Custom fields are managed with create_field, update_field and delete_field, and ticket types with create_ticket_type, update_ticket_type and archive_ticket_type. The change applies to the live page at once: customers see it right away. There is no undo, because the previous values are not kept. For the page's design and customer-facing labels (including translations), set themeOverrides and hostedLayoutType; list_theme_properties lists what can be set. Set themeId (from list_themes) to use a theme; changing it replaces the page's own theme settings.

Input Schema

TableJSON Schema

Name	Required	Description
`tax`	No
`fees`	No
`name`	No	Internal page name used in your dashboard and API responses.
`slug`	No	Page URL slug. For events and forms the slug defaults to the slugified version of your `title`. For checkouts the slug defaults to the slugified version of your `productData.title`.
`title`	No
`locale`	No
`pageId`	Yes	The ID of the event page to update.
`status`	No
`themeId`	No	The theme the page uses: one of your themes or a built-in one (see List themes). Changing it replaces all of the page's own theme settings, including order bump styling set in the dashboard, so the page looks like the theme. That drops the page's labels too, translations included: send the ones to keep in `themeOverrides` in the same request, which apply on top. The page's locale is kept.
`imageIds`	No
`redirect`	No	If enabled, redirects the customer to the specified URL before the page loads.
`testmode`	No	Puts the page in test mode. While it is on, every purchase on this page is a test purchase: no money is taken, the buyer still receives everything the page delivers, and the records are created with `livemode: false`. Turn it off to take real payments again.
`description`	No
`funnelSteps`	No	Ordered funnel configuration for this page. Supports intermediate checkout steps, one-click upsells, and confirmation behavior. Field references inside upsell/confirmation redirect steps resolve by `fieldId` (get current field IDs from the page detail response) — the create-time `fieldKey` string is rejected.
`googleIndex`	No	Allow Google to index this page for search results. Defaults to `true`.
`notifyEmail`	No	Email addresses to send notifications to. Supports comma separated emails.
`redirectUrl`	No	URL to redirect to after payment. Applies if `afterPaymentAction` is `redirect`.
`eventDetails`	No	Event-specific details like type, dates, location. Ticket-specific discounts (`discounts[].ticketTypeIds`) must reference existing ticket types by `{ id }` — update cannot create new ticket types to key against, so the create-time `{ key }` form is rejected.
`trackingCodes`	No	Custom tracking scripts to include on the page. Supports HTML `<script>` tags.
`paymentMethods`	No
`paymentOptions`	No
`redirectPageId`	No	ID of the page (checkout, event or form) to redirect to after payment. Applies when `afterPaymentAction` is `checkout`.
`themeOverrides`	No	The page's design and labels, set on top of its theme and nested by theme property path: `tokens.colorPrimary` is sent as `{ "tokens": { "colorPrimary": { "light": "#1A73E8" } } }`. Keys you leave out keep their current value, and `null` resets a property, or everything under a key, to the theme default. Call `list_theme_properties` for the supported properties, their value formats and, where a property has a fixed one, its default.
`invoiceSettings`	No
`redirectUrlPath`	No	Additional path parameters appended to the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` (the persisted field ID, from the page detail response) instead of the create-time `fieldKey`. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)
`hostedLayoutType`	No
`redirectUrlQuery`	No	Query parameters for the `redirectUrl`. Applies if `afterPaymentAction` is `redirect` and `redirectUrl` is set. To reference a field value, use `fieldId` instead of the create-time `fieldKey`. [Learn more](https://checkoutpage.com/docs/articles/add-field-and-variant-data-to-redirect-url)
`allowDynamicLabel`	No
`allowDynamicPrice`	No
`allowDynamicTitle`	No	Allow page title to be overridden via URL query parameters.
`savePaymentMethod`	No
`afterPaymentAction`	No	Behavior after checkout. `confirmation` shows the confirmation page. `checkout` redirects to `redirectPageId`. `redirect` sends the customer to `redirectUrl`. Defaults to `confirmation`.
`checkoutAbandonment`	No
`showCouponCodeField`	No
`sendEmailConfirmation`	No	Send an email confirmation to the customer. Defaults to `true`.
`redirectUrlInsideEmbed`	No	If the page is embedded, redirect the customer within the embed instead of redirecting the main browser window. Defaults to `false`.
`allowDynamicDescription`	No	Allow page description to be overridden via URL query parameters.
`allowDynamicRedirectUrl`	No
`sendPaymentNotification`	No	Send payment/submission notification emails to the store owner.
`showCouponCodeFieldType`	No
`closePopupOnClickOutside`	No	Whether a popup embed closes when clicking outside the container. Defaults to `false`.
`confirmationEmailMessage`	No	Custom confirmation email message. Accepts HTML or plain text.
`confirmationEmailSubject`	No	Custom confirmation email subject.
`confirmationCheckoutTitle`	No	Confirmation title.
`confirmationEmailShowLogo`	No	Show store logo in confirmation email.
`showConfirmationEventName`	No
`customizeEmailConfirmation`	No	Use a custom email confirmation template. If enabled, provide `confirmationEmailSubject` and `confirmationEmailMessage`.
`confirmationCheckoutMessage`	No	Confirmation message. Accepts HTML or plaintext.
`showConfirmationEventAddOns`	No
`allowDynamicPreselectedPrice`	No
`showConfirmationEventTickets`	No
`customizeCheckoutConfirmation`	No	If set to true `confirmationCheckoutMessage` and `confirmationCheckoutTitle` will be displayed on the confirmation page. Defaults to `false`.
`showConfirmationAddToCalendar`	No
`showConfirmationEventDateTime`	No
`showConfirmationEventLocation`	No
`confirmationEmailShowStoreName`	No	Show store name in confirmation email.
`allowDynamicDiscountedFromPrice`	No
`showConfirmationEventMeetingLink`	No

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedOct 15, 2026

TDQS

A4.5/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true, but the description goes well beyond that: it says the change hits the live page immediately, that there is no undo, that previous values are not retained, and that setting `themeId` overwrites the page's own theme settings and labels including translations. These are exactly the consequences an agent must surface before calling a destructive write.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The critical constraints (live effect, no undo) are front-loaded in the middle of the paragraph rather than buried, and every sentence carries actionable content. It runs long at roughly seven sentences and the sibling enumeration could be tightened, but there is no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive 58-parameter update with an output schema, the description covers the highest-risk behaviors, partial-update guidance, and where to look up theme values. It does not state what happens to omitted fields beyond the 'subset of create's fields' hint, which is the one meaningful gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 53% across 58 parameters, so most parameters are documented in the schema, but the description adds real semantics for only a handful: `themeOverrides`, `hostedLayoutType`, and `themeId`. It correctly points to `list_theme_properties` and `list_themes` for valid values, but the large majority of the 58 parameters get nothing from the description, so it does not compensate for the coverage gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence states a precise verb and resource ('Update an existing event page's content and settings'), and the sibling landscape (update_checkout_page, update_form) makes the scope unambiguous. It also flags that only a subset of create's fields is supported, which an agent needs in order to distinguish this from create_event.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives an explicit prerequisite ('read current values with get_event before a partial update') and routes adjacent work to the correct siblings: fields to create_field/update_field/delete_field and ticket types to create_ticket_type/update_ticket_type/archive_ticket_type. When-to-use and when-to-use-something-else are both stated, not implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Checkout Page tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?