Forms tools

An operation tool runs one API operation and takes its variables, so the operation's page says what each accepts. Two differences: the server fills in workspaceId and updatedBy, and campaignId, partnerId, formId, discountCodeId, socialNetworkId, waitlistId, incentiveId, channelId also take the record's name. A task tool chains several operations and is described here in full. Every tool's input schema, keyed by tool name: forms.schema.json.

Operation tools

Tool	Operation	Access	Toolset	Hints	What it does
add_form_placement	AddFormPlacement	Write	forms		Place a form on a connection surface (storefront, email or QR).
create_form	CreateForm	Write	forms		Create a form; body carries title, surfaces and view type. Invalid input returns userErrors.
delete_form	DeleteForm	Write	forms	destructive	Delete a form and its placements. Irreversible.
get_form	FormBuilder	Read	core	read-only, idempotent	Get one form by slug with its placements, draft snapshot and settings.
get_form_channels	FormChannels	Read	forms	read-only, idempotent	List the surfaces a form can be placed on (storefront, email, QR) per integration.
get_form_incentives	FormIncentives	Read	forms	read-only, idempotent	List the incentives attached to the given forms.
get_form_insight_read	FormInsightRead	Read	forms	read-only, idempotent	Insight facts, answers and reasons mined from form responses, with filters.
get_form_install	FormInstall	Read	forms	read-only, idempotent	Install state for one form: its placements and verified storefront domains.
get_form_response	FormResponseDetail	Read	forms	read-only, idempotent	Get one form response with every answer, the verdict that scored it and the order it earned.
get_form_responses_surface	FormResponsesSurface	Read	forms	read-only, idempotent	Responses for one form in a window: the list, counts by placement and the funnel.
get_form_short_links	FormShortLinks	Read	forms	read-only, idempotent	List the short links and QR targets for forms.
list_forms	FormsList	Read	core	read-only, idempotent	List forms with a filter: slug, title, status, surfaces, tags and A/B share.
get_form_triggers	FormTriggers	Read	forms	read-only, idempotent	List the triggers (when to show) for the given forms.
get_promotion_rotation	PromotionRotation	Read	forms	read-only, idempotent	Which forms rotate on the published surface, and their A/B shares.
publish_form	PublishForm	Write	forms		Publish a form's draft as its live version.
remove_form_placement	RemoveFormPlacement	Write	forms	destructive	Remove a form placement. Irreversible.
replace_form_triggers	ReplaceFormTriggers	Write	forms	destructive	Replace a form's triggers; the old ones are not kept. Irreversible.
rotate_form_public_key	RotateFormPublicKey	Write	forms	destructive	Rotate a form placement's public key; embeds using the old key stop working. Irreversible.
save_form_draft	SaveFormDraft	Write	forms		Save a form's draft content.
set_form_placement_copy	SetFormPlacementCopy	Write	forms	idempotent	Set a form placement's copy.
set_form_placement_published	SetFormPlacementPublished	Write	forms	idempotent	Publish or unpublish a form placement.
set_form_placement_qr_style	SetFormPlacementQrStyle	Write	forms	idempotent	Set a form placement's QR code style.
set_form_promotion	SetFormPromotion	Write	forms	idempotent	Set which forms rotate on the published surface and their shares.
set_short_link_disabled	SetShortLinkDisabled	Write	forms	idempotent	Enable or disable a short link.
update_form	UpdateForm	Write	forms		Update a form's title, surfaces, priority, status or schedule.
verify_form_placement	VerifyFormPlacement	Write	forms		Check that a form placement is installed on the storefront.