Checkout Page

update_form

Destructive

Update an existing form page's content and settings. Supports a subset of create's fields; read current values with get_form before a partial update. Custom fields are managed with create_field, update_field and delete_field. 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
`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	Public title shown to customers on the page.
`locale`	No
`pageId`	Yes	The ID of the form page to update.
`status`	No
`fileIds`	No	Array of file IDs for downloadable files. All file IDs must exist and belong to your account.
`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	Array of images for the page gallery. All referenced file IDs must exist and belong to your account.
`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	Page description shown to customers. Accepts HTML or plain text.
`formDetails`	No	Form behaviour settings.
`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`.
`trackingCodes`	No	Custom tracking scripts to include on the page. Supports HTML `<script>` tags.
`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)
`allowDynamicTitle`	No	Allow page title to be overridden via URL query parameters.
`afterPaymentAction`	No	Behavior after checkout. `confirmation` shows the confirmation page. `checkout` redirects to `redirectPageId`. `redirect` sends the customer to `redirectUrl`. Defaults to `confirmation`.
`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.
`sendPaymentNotification`	No	Send payment/submission notification emails to the store owner.
`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.
`customizeEmailConfirmation`	No	Use a custom email confirmation template. If enabled, provide `confirmationEmailSubject` and `confirmationEmailMessage`.
`confirmationCheckoutMessage`	No	Confirmation message. Accepts HTML or plaintext.
`customizeCheckoutConfirmation`	No	If set to true `confirmationCheckoutMessage` and `confirmationCheckoutTitle` will be displayed on the confirmation page. Defaults to `false`.
`confirmationEmailShowStoreName`	No	Show store name in confirmation email.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedOct 15, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Annotations already declare destructiveHint=true and non-read-only, so the safety profile is known. The description adds valuable specifics beyond that: changing themeId 'replaces all of the page's own theme settings' and 'drops the page's labels too, translations included', plus the partial-update contract. It could still say more about auth/permissions, but the destructive mechanics are well surfaced.

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?

Four front-loaded sentences that move from purpose to workflow guidance to design-field mechanics, with no filler. Dense but every sentence carries routing or behavioral information; only the themeOverrides/themeId sentence partially overlaps the schema.

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 39-parameter destructive mutation with an output schema and full annotations, the description covers the high-risk pieces (themeId replacement side effects, partial-update pattern, field management, theme overrides) adequately. It does not attempt to enumerate the many minor flags, which is reasonable given the schema covers them.

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 90%, so the schema already documents nearly every parameter (including themeId, themeOverrides, hostedLayoutType details). The description restates the themeOverrides/themeId semantics that the schema itself carries, adding little beyond it. Baseline 3 is appropriate when the schema does the heavy lifting.

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?

States a specific verb+resource ('Update an existing form page's content and settings') and immediately scopes it against siblings: a subset of create's fields, get_form for reading, and create_field/update_field/delete_field for custom fields. An agent can distinguish this from update_checkout_page/update_event without opening any schema.

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

Usage Guidelines4/5

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

Gives concrete routing advice: read current values with get_form before a partial update, manage custom fields with the *_field tools, and consult list_theme_properties/list_themes before setting design fields. It stops short of explicitly disambiguating against sibling update_checkout_page/update_event, but the guidance present is specific and actionable.

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?