Every MCP tool, the ability it requires, and an example call.
Updated . 86 min read.
Every tool checks the token's abilities before running; missing the ability returns a refusal. The tables below cover the complete workspace surface area registered on the server (628 tools).
Risk classes and approval
Every tool has a risk class: read, write, destructive, external_send, financial, credential or access_control. A token that asks for approval waits for you before any tool in the last five classes, and never for reads or ordinary edits. The class of a tool, the ability it needs and the arguments of the call are shown on the approval page. See Ask me before risky actions for the full list and how approval works.
* * *
Plan visibility
tools/list, resources/list, and prompts/list are filtered by the authenticated team's plan. On Free, survey, funnel, webhook, and AI tools (and their matching resources/prompts) are omitted entirely - clients that only read the list will not see them. On Pro and above, the full catalogue is returned.
You can still mint token abilities for paid products on any plan; without the plan feature, those tools either never appear in the list or refuse at call time with a plan error.
Plan
MCP products available
Free
Forms, submissions, links, polls, bio pages, automations, workspace and account settings, billing, developer tools, tokens, framework catalog
Pro and above
Everything in Free + webhooks, surveys, funnels, bookings, feedback, contacts, AI features
Team and above
Everything in Pro + single sign-on and the agency client portal
Scale
Everything in Team + Response Desk and the knowledge base
* * *
Product routing
Forms - single-screen contact-style forms. Use create_form, not create_survey.
Surveys - multi-screen questionnaires, quizzes, NPS. Use create_survey, not create_form.
Funnels - multi-step lead-gen with screens, blocks, scoring, pixels, CAPI. Use create_funnel.
Links - branded short links and QR codes on every plan.
Bio pages - link-in-bio profile pages. Use create_bio_page.
Polls - single-question votes with live results. Use create_poll.
Feedback - ideas portal with voting, roadmap, and changelog. Use create_feedback_board.
Bookings - appointment pages on a connected calendar. Use create_booking_page.
Knowledge - help-center articles and collections. Use create_knowledge_article.
Response Desk - one inbox for conversations across channels. Use list_desk_threads and reply_desk_thread.
Workspace, Teams, Agency, Billing, Account - workspace settings and theme, projects, members and invitations, single sign-on, email sending, the agency client portal, subscription management, and your profile. Payment details and sign-in with a passkey always happen in the browser; the tools return a link to open.
Guided create - list_wizard_recipes and create_from_wizard build a product from a few outcome answers, the same as the dashboard's guided setup.
Call list_templates with product (form, survey, or funnel) before create_* when the user wants a starter. Pass the returned key as template on create_form, create_survey, or create_funnel.
* * *
Build a complete form, survey, or funnel in one call
set_form_document, set_survey_document, and set_funnel_document are the full authoring path. Each one builds a complete, styled product end-to-end from a single builder document - every field/question type, content blocks, conditional branching, welcome and ending screens, and styling - the same structure the visual builder saves. Prefer them over update_* (or add_screen / add_block) when you are laying out or restyling a product rather than patching one attribute.
Each create_* returns a public_id; pass it as form_id, survey_id, or funnel_id. Pass publish: true to make the result live in the same call.
builder - the product name plus product-level settings (e.g. survey display_mode / progress).
blocks[] - the ordered content. Each block has an id, a kind, and a position. A question block carries one or more elements (the input fields / content). welcome, ending_screen, and ending_redirect blocks carry their copy in config. Ids and per-element config defaults are filled in when omitted.
theme_v2 - the unified styling envelope (colors, fonts, radius, spacing, ...) under tokens. This is the canonical styling surface and round-trips with the visual Styling editor. update_* accepts the same theme_v2 when you only want to restyle.
Element vocabulary
The type on each element reaches the full builder palette:
Content blocks render without collecting a submission key: heading, paragraph (a statement, not a textarea input), html, divider. (A typed email input is an open_text element with config.format: "email".)
Forms and surveys reject an unmapped type with a clear error (so a typo never silently drops a field).
Funnels never reject an unmapped type. Any type with no native funnel block (nps, matrix, csat, ...) degrades loss-free to an inert html block that preserves the original type, so layout and styling always save. Funnel screens that stack several inputs or advance buttons are auto-split one step per screen.
Conditional branching (logic)
Attach a logic rule graph to any question block to branch on an answer. then.action is goto / skip / next, and then.target is the id of the block to jump to (rewritten internally to the right screen):
Branching round-trips: re-saving a survey or funnel preserves the rules so a later edit never drops a jump.
Welcome and ending screens carry a body
Welcome and ending screens now support a multi-paragraph body alongside the headline and button_label. Author it with newline-separated paragraphs; the hosted page renders and themes each paragraph.
A funnel document uses one block per screen (a step); each screen's fields/content are its elements. Unmapped types degrade to html rather than failing.
update_form, update_survey, and update_funnel now also set the surrounding configuration the document does not own:
Captcha is always per-entity, never global. Set hcaptcha_enabled / recaptcha_enabled plus the matching *_site_key / *_secret on the individual form, survey, or funnel. Leaving a secret empty keeps the existing key so an unrelated edit never wipes stored credentials.
Scoring (scoring), hidden fields (hidden_fields, captured from URL params), notification emails (notification_emails), autoresponder (autoresponder), redirect (redirect_url), and the spam honeypot (honeypot_field).
List starter templates; optional category and search filters. Survey and funnel products require a paid plan.
* * *
Forms
Tool
Ability
Description
list_forms
forms:read
List active forms in the team
get_form
forms:read
Fetch one form by public_id
create_form
forms:write
Create a new form (optional template key from list_templates)
update_form
forms:write
Patch name, slug, a full builder document (all field + content types + theme + welcome/ending), legacy fields, theme, settings (including who may respond, respondent edits and resumable drafts, plus the invited access_allowlist), notification emails, autoresponder, redirect, honeypot, and per-form captcha
set_form_document
forms:write
Build a complete, styled form in one call from a builder document. See Build in one call
publish_form
forms:write
Set published_at = now()
unpublish_form
forms:write
Clear published_at
archive_form
forms:write
Soft-delete
restore_form
forms:write
Reverse archive
send_test_autoresponder
forms:test-email
Send preview autoresponder to your account email
send_test_notification
forms:test-email
Send preview owner-notification
* * *
Submissions
Tool
Ability
Description
list_submissions
submissions:read
Paginate, filter by folder and lifecycle state (draft, abandoned, accepted)
get_submission
submissions:read
Fetch one with files, its state and revision; include_revisions adds the edit history
update_submission
submissions:write
Patch payload or status; expected_revision refuses a stale edit
delete_submission
submissions:write
Permanent delete + file cleanup
bulk_submissions
submissions:write
Up to 500 ids: delete, mark_spam, mark_not_spam
export_submissions
submissions:export
Inline JSON, up to 500 rows
get_submission_file
submissions:read
Short-TTL signed URL
mark_as_spam
submissions:write
Quick mark with reason manual:mcp
get_form_stats
submissions:read
30-day totals, spam ratio, AI score average
import_form_responses
submissions:write
Import a CSV or JSON export: dry run, confirm, or retry failed rows
get_form_import_run
submissions:read
Counts per outcome, reconciliation and what did not carry over
* * *
Webhooks
Tool
Ability
Description
list_webhooks
webhooks:read
Webhooks for a form, with delivery counts
get_webhook
webhooks:read
Single webhook (no secret)
create_webhook
webhooks:write
Returns plaintext signing secret ONCE
update_webhook
webhooks:write
URL, label, active flag
rotate_webhook_secret
webhooks:write
Rotate the signing secret with an overlap window; the new secret is shown once
delete_webhook
webhooks:write
Remove
list_webhook_deliveries
webhooks:read
Last 50 (configurable up to 200)
replay_webhook_delivery
webhooks:write
Re-dispatch a previous delivery
get_form_record_sync
webhooks:read
How a form updates existing HubSpot, Airtable or Notion records
save_form_record_sync
webhooks:write
Mapping, conflict policy and links to related records
set_form_record_sync_state
webhooks:write
Preview, enable, disable, reconcile or remove
resolve_form_record_sync_operation
webhooks:write
Settle a conflict or a row that needed review
* * *
Surveys
Surveys are a separate product from Forms - multi-screen questionnaires, quizzes, and NPS flows with conditional logic. Never call create_form to make a survey, or create_survey to make a contact form. All survey tools require a paid plan.
Build a complete, styled survey - questions, branching, theme - in one call from a builder document. See Build in one call
publish_survey
surveys:write
Publish - make the survey live and respondable
unpublish_survey
surveys:write
Return to draft, stop accepting responses
delete_survey
surveys:write
Soft-delete (recoverable from the dashboard)
get_survey_insights
insights:read
Read open-text AI insights (summary, sentiment, theme clustering) for a survey; returns { locked: true } when the plan lacks AI features
regenerate_survey_insights
insights:write
Queue regeneration of a survey's open-text AI insights; optionally limit to one question by submission key. Idempotency-locked for 5 minutes
Surveys capture CRM contacts from responses. A survey mints a contact whenever it has at least one typed email question. Capture is opt-in per email question via save_as_contact, which defaults on - set it false on a specific question (e.g. "your colleague's email") to opt that one out. Identity is read only from typed email / phone questions, never by scanning free-text answers. Set save_as_contact in the element config when building with set_survey_document.
* * *
Action classes
Action classes are the triggers that decide when an in-app or website survey fires - a code action fires from an SDK track(key) call, a noCode action auto-fires from a spec (page view, click, exit intent, scroll depth, dwell, with optional URL filters). A survey fires when any of its attached triggers fires. Part of the in-app / website survey suite; requires a paid plan.
Tool
Ability
Description
list_action_classes
action-classes:read
List action classes (survey triggers) for the current team
get_action_class
action-classes:read
Fetch a single action class by public_id
create_action_class
action-classes:write
Create a trigger; code actions fire from an SDK track(key) call, noCode actions auto-fire from a no_code_config spec (page view / click / exit intent / scroll / dwell with optional URL filters)
update_action_class
action-classes:write
Update name, description, type, key, or no_code_config; partial payloads are last-write-wins
delete_action_class
action-classes:write
Delete a trigger and its survey-trigger links; surveys simply stop firing on it. Queued
attach_survey_trigger
action-classes:write
Attach a trigger to a survey (idempotent)
detach_survey_trigger
action-classes:write
Detach a trigger from a survey (idempotent)
* * *
Contacts
The CRM audience captured from in-app / website survey responses (and managed directly). A contact is identified by external_user_id and/or email; attributes merge last-write-wins. Requires a paid plan.
Tool
Ability
Description
list_contacts
contacts:read
List contacts belonging to the current team
get_contact
contacts:read
Fetch a single contact by public_id, including its merged attributes
create_contact
contacts:write
Create or upsert a contact (identified by external_user_id and/or email; attributes are merged)
update_contact
contacts:write
Backfill identity (email / external_user_id) and merge attributes (last-write-wins)
delete_contact
contacts:write
Erase a contact and its attributes; survey responses are de-identified, not deleted. Queued
* * *
Segments
Segments are reusable survey audiences: each owns a recursive AND/OR filters tree over contact attributes, device class, and nested segment membership. A survey targets one segment. Part of the in-app / website survey suite; requires a paid plan.
Tool
Ability
Description
list_segments
segments:read
List segments (survey audiences) for the current team
get_segment
segments:read
Fetch a single segment by public_id
create_segment
segments:write
Create a segment with a recursive AND/OR filters tree over contact attributes, device class, and nested segment membership
update_segment
segments:write
Update title, description, privacy, or filters; partial payloads are last-write-wins
delete_segment
segments:write
Delete a segment; any survey targeting it becomes unsegmented (shows to everyone). Queued
assign_survey_segment
segments:write
Set a segment as a survey's audience (a survey targets one segment)
unassign_survey_segment
segments:write
Clear a survey's audience segment (it becomes unsegmented and shows to everyone)
* * *
Data tables
Reference tables (rate cards, zones, stock lists) that form formulas read with lookup() and band(). A customer system or an agent can push rows into them. Tables that refresh from an API cannot be pushed to; use refresh_data_table for those. See Push data with the API.
Tool
Ability
Description
list_data_tables
data-tables:read
List the team's data tables with columns and row counts
get_data_table
data-tables:read
Fetch one table with a page of rows (max 100 per page)
create_data_table
data-tables:write
Create a table with a name, a formula slug, 1-20 columns, and optional first rows
update_data_table
data-tables:write
Rename a table or change its slug
replace_data_table_rows
data-tables:write
Replace the whole table in one step (max 5,000 rows); an invalid payload changes nothing
upsert_data_table_rows
data-tables:write
Update rows matching a key_column and add the rest; the result is capped at 5,000 rows
delete_data_table
data-tables:write
Delete a table. Queued
refresh_data_table
data-tables:write
Fetch an API-linked table again now, limited to 6 a minute
* * *
Documents and signing
Generate PDF documents from a response (an HTML template or an uploaded PDF form) and ask people to sign them with a simple electronic signature. Rendering is asynchronous: generate_document queues it, list_documents shows queued, rendering, ready or failed with the reason, and retry_document tries a failed one again. Signing requests never claim a qualified signature, and only the recipient can sign: each recipient confirms their own email address with a code and signs for themselves, so no tool can sign or record consent for anyone. Sending, reminding, voiding and creating can require a person's confirmation when the token asks for it. Both are included with the Scale plan, with a monthly allowance; a plan or allowance error comes back as a plain message. See Documents and Electronic signing.
Tool
Ability
Description
list_document_templates
documents:read
List a form's document templates, newest version first
generate_document
documents:create
Queue a PDF from a template version for one response
list_documents
documents:read
List a response's documents with status, failure reason, signing requests and the monthly allowance
retry_document
documents:create
Retry a failed render
get_document_file
documents:read
Download a ready PDF as base64 (up to 10 MB)
create_signing_request
documents:create
Prepare a draft request for 1 to 10 people, in order or at once. It never sends; call send_signing_request
get_signing_request
documents:read
Read the status, signers, per-recipient delivery state, reminders and whether the event history still verifies
send_signing_request
signing:send
Send the invitations of a draft request. Can require a person's confirmation
remind_signers
signing:send
Email a fresh link to every signer whose turn it is; a signer waits an hour between manual reminders
void_signing_request
signing:void
Cancel an unfinished request; every link stops working
get_signing_metrics
documents:read or insights:read
Signing metrics from durable records: sent, finalized, completion rate, recipients invited, verified and signed, time to first signature and to completion, reminders and failures. Viewed is not a conversion; test and sample requests are excluded
get_signing_evidence
signing:export
A redacted summary and the REST download path of the evidence bundle and the signed PDF; the files are not returned inline
get_signing_retention
signing:settings
The retention periods in force, the open legal holds and a dry run of what the next daily sweep would remove (counts and a capped sample of request ids and titles). Removes nothing
set_signing_retention
signing:settings
Save the retention periods for drafts, ended requests and completed records (null means no automatic purge). Can require a person's confirmation
place_signing_hold
signing:settings
Keep one request out of every retention sweep, with a reason and a review date; recorded in the request history
release_signing_hold
signing:settings
Release a hold so the request follows the retention periods again. Can require a person's confirmation
* * *
SDK keys
Public environment keys the in-app / website survey SDK embeds in the browser. Each key carries an allowed_origins CORS allow-list - an empty list denies all cross-origin browser use, so add your production origins explicitly. Part of the in-app / website survey suite; requires a paid plan.
Tool
Ability
Description
list_sdk_keys
sdk-keys:read
List the team's public SDK keys
get_sdk_key
sdk-keys:read
Fetch a single SDK key by its public key value
create_sdk_key
sdk-keys:write
Mint a new public SDK key; allowed_origins is a CORS allow-list and an empty list denies all cross-origin use
update_sdk_key
sdk-keys:write
Rename, replace the allowed_origins CORS list, or toggle is_active; passing allowed_origins replaces the whole list (empty array denies all cross-origin use)
rotate_sdk_key
sdk-keys:write
Give a key a new public value; the old value keeps working for overlap_hours (default 24, max 168), or pass end_overlap to retire it now
revoke_sdk_key
sdk-keys:write
Deactivate the key (rejected immediately) and soft-delete it; historical displays/responses are preserved. Queued
* * *
Displays
Read-only analytics over survey displays / impressions captured by the SDK. Part of the in-app / website survey suite; requires a paid plan.
Tool
Ability
Description
list_displays
displays:read
List survey displays / impressions; optionally filter by survey_id and unresponded-only
get_display
displays:read
Fetch a single display / impression by public_id
get_survey_display_analytics
displays:read
Display-funnel analytics for a survey - completion rate, per-question drop-off, time-to-complete; optional date range and segment / contact-attribute filter
* * *
Funnels
Funnels are multi-step lead-gen / quiz funnels with screens, blocks, scoring, pixels, A/B tests, and server-side CAPI. All funnel tools require a paid plan. Funnel tools accept either public_id (preferred, mirrors forms/surveys) or the legacy slug to identify a funnel.
Tool
Ability
Description
list_funnels
funnels:read
List funnels for the current team
get_funnel
funnels:read
Get a funnel by public_id (preferred) or slug
create_funnel
funnels:write
Create a blank funnel or hydrate a gallery template via template
update_funnel
funnels:write
Update top-level config and replace screens. Sets theme / theme_v2 styling, tracking pixels, A/B config, autoresponder, notification emails, honeypot, hidden fields, allowed origins, and a full ordered screens array (id-diff upsert)
set_funnel_document
funnels:write
Build a complete, styled multi-step funnel - screens, blocks, branching, theme - in one call from a builder document. See Build in one call
publish_funnel
funnels:publish
Publish or unpublish a funnel
delete_funnel
funnels:write
Soft-delete (recoverable)
get_funnel_analytics
funnels:analytics
Funnel analytics summary, including the split of scored submissions across outcome bands (outcomes, scored_total)
get_funnel_attribution
funnels:analytics
Source-to-outcome report: leads, qualified leads, bookings, orders and net revenue per source. model is journey_source (default), first_touch, last_touch or linear; lookback_days (1-90) limits the multi-touch models
record_funnel_crm_outcome
funnels:write
Report a CRM stage or won/lost for a funnel lead (submission_id, stage or status, optional value_minor and currency); idempotent per source_fact_id(Pro and above)
record_funnel_revenue_adjustment
funnels:write
Record a refund or dispute against a funnel order (order_fact_id, amount_minor); net revenue moves, qualified leads do not; idempotent per source_fact_id(Pro and above)
list_funnel_sessions
funnels:analytics
Recent sessions for a funnel
add_screen
funnels:write
Add a screen to a funnel
add_block
funnels:write
Add a block to a funnel screen
set_logic
funnels:write
Attach an AND/OR DSL logic rule to a block
set_score
funnels:write
Attach a per-block score map (bucket → points). Score bands (outcomes) are set with the outcomes list of set_funnel_document
Configure server-side CAPI credentials for a vendor (meta / tiktok / linkedin / pinterest)
* * *
Links
Branded short links and QR codes. Available on every plan.
Tool
Ability
Description
list_links
links:read
List short links for the current team
get_link
links:read
Fetch one short link by id or slug
create_link
links:write
Create a new short link
update_link
links:write
Update an existing short link
delete_link
links:write
Soft-delete a short link
* * *
Bio pages
A Bio page is a single public link-in-bio profile (handle, avatar, headline, bio) listing many ordered blocks. It is not a form, survey, funnel, or single link - use these tools, never create_form / create_survey / create_funnel / create_link. Requires a plan that includes Bio Pages.
Tool
Ability
Description
list_bio_pages
bio:read
List link-in-bio profile pages for the current team
get_bio_page
bio:read
Fetch one page by id or handle, including its blocks
create_bio_page
bio:write
Create a new profile page (a single public page listing many blocks)
update_bio_page
bio:write
Update the page profile and publish state
set_bio_document
bio:write
Build or restyle an entire bio page from a builder document (all block types + theme), replacing the page's blocks in one call
set_bio_pixel
bio:write
Set one browser-side tracking pixel ID on a page (GA4 / GTM / Meta / TikTok)
add_bio_block
bio:write
Append or insert one content block (link, header, text, social, embed, image, form, ...) onto a page
reorder_bio_blocks
bio:write
Reorder a page's blocks by id
delete_bio_block
bio:write
Remove a single block (cascades its managed short link / files)
delete_bio_page
bio:write
Delete a page; disabled immediately, hard delete queued
* * *
Automations
Per-form automation rules with steps that fire on submission events. Available on every plan. Use list_automations with a form's public_id, or with target_type: "workspace" (no id) for the workspace-level automations that start on contact, account, desk and other workspace events; the team-wide formspring://team/automations resource lists automations across forms, surveys, and funnels.
Tool
Ability
Description
list_automations
automations:read
List automations for a form (form_id = form public_id)
get_automation
automations:read
Get a single automation with its steps
create_automation
automations:write
Create a new automation
update_automation
automations:write
Update top-level fields (steps via dedicated tools)
enable_automation
automations:write
Enable an automation
disable_automation
automations:write
Disable an automation
delete_automation
automations:write
Permanent delete (with steps + runs)
run_automation
automations:run
Manually trigger an automation, or (with object and records) run a workspace automation on up to 100 records of an object
list_automation_runs
automations:read
List recent runs
get_automation_run
automations:read
Get one run with per-step outputs
replay_automation_run
automations:run
Replay a previous run
cancel_automation_run
automations:run
Cancel a run that has not finished, with its child and branch runs
resume_automation_run
automations:run
Resume a failed, needs-review or limit-paused run at the step that stopped it (high risk with retry: it can send twice)
list_automation_test_inputs
automations:read
The data past runs started with, masked and without secrets, to test with
list_automation_versions
automations:read
List the saved versions of an automation
get_automation_version
automations:read
Read one version with the connections it relies on and their state
restore_automation_version
automations:write
Make an earlier version the live definition again
get_automation_limits
automations:read
Plan limits, the workspace's own caps and usage, including AI usage
set_automation_limits
automations:write
Lower the workspace's own caps
* * *
Billing (plan and usage)
Tool
Ability
Description
get_team
billing:read
Current team summary
get_plan
billing:read
Plan key, features, limits
get_usage
billing:read
Current period: submissions, storage, deliveries
get_subscription_state
billing:read
active / on_trial / on_grace_period / past_due / canceled
* * *
AI Insights
Tool
Ability
Description
get_ai_insights
insights:read
Insights payload (or { locked: true })
regenerate_ai_insights
insights:write
Trigger regen; locked 5 min between calls
* * *
Tokens (self-management)
Tool
Ability
Description
list_tokens
tokens:read
Your own tokens
create_token
tokens:write
Mint a token; abilities ⊆ caller's
revoke_token
tokens:write
Revoke (refuses on the active token)
* * *
Integration reference
Tool
Ability
Description
get_framework_integration_catalog
forms:read
Returns a maximum-breadth matrix of stacks (React, Next.js, Laravel, WordPress, mobile, serverless, ...): each row includes a short copy-paste snippet (placeholder FORMSPRING_ENDPOINT → your https://.../f/{public_id}), notes (CORS, hosted vs legacy payloads, etc.), docs_url into this site's /docs/..., and optional recipe_slug when a long-form recipe exists. Supports optional category (spa, ssr, static, mobile, backend, cms, edge) and pagination page / per_page (max 100 per page). Deep guides remain on the docs site; MCP returns the compact matrix.
The sections above list the original tools. The tables below cover everything else the server registers, so the assistant can do anything you can do in the dashboard. Tools marked with a plan name are only listed on that plan and above.
Forms
Tool
Ability
Description
move_form
forms:write
Move a form to another project (same checks as the dashboard)
force_delete_form
forms:write
Permanently delete a form in the background
list_form_versions
forms:read
List the builder version history of a form
restore_form_version
forms:write
Restore a form version non-destructively (audited)
add_form_comment
forms:write
Add an internal form comment with @mention notifications
get_form_analytics
forms:read
Form analytics overview, per-field drop-off and chart series
get_form_attribution
submissions:read
Where responses came from, credited by the shared attribution model and window (model, window_days): sources, campaigns and ad-platform click-id totals captured on the form page when the visitor permitted analytics; the rest are unattributed
record_form_crm_outcome
submissions:write
Report a CRM stage or qualified/won/lost for a form response (submission_id, stage or status, optional value_minor and currency); credited to the response's source; idempotent per source_fact_id
record_form_revenue_adjustment
submissions:write
Record a refund or dispute against a won form deal (order_fact_id, amount_minor); idempotent per source_fact_id
get_form_document
forms:read
Read the builder document the visual builder opens
list_form_languages
forms:read
List form translation languages and language-switch flag
add_form_language
forms:write
Add a translation language to a form
update_form_language
forms:write
Rename / enable / make default a form language
delete_form_language
forms:write
Remove a non-default form language
update_form_language_settings
forms:write
Toggle the public language switch
translate_form_language
forms:write
Queue machine translation of a form language (returns a locked response without AI) (Pro and above)
create_form_from_template
forms:write
Create a draft form from a gallery template or blank
Submissions
Tool
Ability
Description
list_responses
submissions:read
Unified Responses inbox across forms, surveys and funnels with filters, folder counts, cursor paging
Queue a csv/json/pdf export of selected rows or filtered responses
get_responses_export
submissions:export
Poll a responses export and get the signed download URL
list_submission_saved_views
submissions:read
List your saved inbox views for a form
save_submission_view
submissions:write
Save/overwrite a named inbox filter view for a form
delete_submission_saved_view
submissions:write
Delete one of your saved form inbox views
list_inbox_saved_views
submissions:read
List cross-form saved views for the Responses inbox
create_inbox_saved_view
submissions:write
Create/overwrite a cross-form saved view
update_inbox_saved_view
submissions:write
Rename/re-filter/reorder a cross-form saved view
delete_inbox_saved_view
submissions:write
Delete a cross-form saved view
add_submission_comment
submissions:write
Add an internal submission comment (mentions + desk mirror)
get_submission_pdf
submissions:read
Render a submission PDF (base64)
update_autoresponder_draft
submissions:write
Edit the reply draft of a submission
send_autoresponder_draft
submissions:write
Send the reply draft to the submitter (queued mail)
discard_autoresponder_draft
submissions:write
Discard the reply draft
regenerate_autoresponder_draft
submissions:write
Queue a fresh AI reply draft (Pro and above)
Webhooks
Tool
Ability
Description
test_webhook
webhooks:write
Queue a test delivery of the latest submission to a webhook (Pro and above)
list_webhook_providers
webhooks:read
List integration providers with required config keys, URL hints and the Sheets connect URL (Pro and above)
sheets_list_tabs
webhooks:write
List tabs of the connected Google spreadsheet (Pro and above)
sheets_header_row
webhooks:write
Read the header row of a spreadsheet tab (Pro and above)
sheets_write_headers
webhooks:write
Write the header row of a spreadsheet tab (Pro and above)
sheets_create_tab
webhooks:write
Create a tab in the connected spreadsheet (Pro and above)
sheets_test_row
webhooks:write
Append a marked test row built from the column mapping (Pro and above)
sheets_backfill
webhooks:write
Queue a backfill of past submissions into the spreadsheet (Pro and above)
Surveys
Tool
Ability
Description
restore_survey
surveys:write
Restore a survey from trash (Pro and above)
force_delete_survey
surveys:write
Permanently delete a trashed survey (queued) (Pro and above)
move_survey
surveys:write
Move a survey to another project/workspace (Pro and above)
list_survey_versions
surveys:read
List survey version history (Pro and above)
restore_survey_version
surveys:write
Restore a survey version as a new version (Pro and above)
list_survey_quotas
surveys:read
List response quotas with fill counts (Pro and above)
create_survey_quota
surveys:write
Add a response quota (Pro and above)
update_survey_quota
surveys:write
Update a response quota (Pro and above)
delete_survey_quota
surveys:write
Remove a response quota (Pro and above)
list_survey_question_comments
surveys:read
List builder question comments (Pro and above)
add_survey_question_comment
surveys:write
Comment on a question, notifying @mentions (Pro and above)
suggest_survey_branch
surveys:write
AI next-question suggestions (returns a locked response without AI) (Pro and above)
translate_survey_language
surveys:write
Queue AI translation of a survey language (Pro and above)
generate_survey
surveys:write
Start an AI survey generation (Pro and above)
get_survey_generation_status
surveys:read
Poll an AI survey generation (Pro and above)
cancel_survey_generation
surveys:write
Cancel an AI survey generation (Pro and above)
list_survey_dashboards
surveys:read
List survey analytics dashboards (Pro and above)
get_survey_dashboard
surveys:read
Read a dashboard with widget data (Pro and above)
create_survey_dashboard
surveys:write
Create a survey analytics dashboard (Pro and above)
update_survey_dashboard
surveys:write
Update a dashboard and replace its widgets (Pro and above)
list_survey_responses
surveys:read
List a survey's responses with folder/search/tag filters, counts and team tags (Pro and above)
get_survey_response
surveys:read
One response with resolved answers, metadata, tags and files (Pro and above)
update_survey_response
surveys:write
Set a response status (received/spam/processed/failed) (Pro and above)
delete_survey_response
surveys:write
Queue deletion of one response (per-row permission check) (Pro and above)
bulk_survey_responses
surveys:write
Bulk delete (queued) / mark spam / mark received, max 500 (Pro and above)
tag_survey_response
surveys:write
Add a tag to a response (Pro and above)
untag_survey_response
surveys:write
Remove a tag from a response (Pro and above)
export_survey_responses
surveys:read
Inline JSON/CSV export of responses (500 rows per call) (Pro and above)
get_survey_response_file
surveys:read
Signed download URL for an uploaded response file (Pro and above)
get_survey_response_pdf
surveys:read
Base64 PDF of one response (when PDF download is enabled) (Pro and above)
get_survey_response_analytics
surveys:read
Completion, score distribution, outcomes, per-screen drop-off (Pro and above)
get_survey_attribution
surveys:read
Where survey responses came from, credited by the shared attribution model and window (model, window_days); respondents who declined analytics are unattributed (Pro and above)
get_survey_report
surveys:read
Per-question results report of the survey detail page (Pro and above)
Save display rules (option, recontact, limit, percentage, delays) (Pro and above)
set_survey_audience_filters
surveys:write
Set the inline audience filter tree (replaces assigned segment) (Pro and above)
preview_survey_reach
surveys:read
Preview audience reach for everyone/segment/custom filters (Pro and above)
list_survey_webhooks
webhooks:read
List survey integrations, providers and Google Sheets reconnect health (Pro and above)
get_survey_webhook
webhooks:read
One survey integration with scrubbed config and last 50 deliveries (Pro and above)
create_survey_webhook
webhooks:write
Connect an integration / add a signed webhook (secret shown once) (Pro and above)
update_survey_webhook
webhooks:write
Update label/url/active/config/allowed hostnames (Pro and above)
delete_survey_webhook
webhooks:write
Remove a survey integration (Pro and above)
rotate_survey_webhook_secret
webhooks:write
Rotate a survey webhook's signing secret with an overlap window; the new secret is shown once (Pro and above)
test_survey_webhook
webhooks:write
Queue a test delivery with the latest response (Pro and above)
replay_survey_webhook_delivery
webhooks:write
Re-send a previous delivery (queued) (Pro and above)
list_survey_sheets_tabs
webhooks:read
List tabs of the connected Google Sheet (Pro and above)
get_survey_sheets_header_row
webhooks:read
Read a tab's header row (Pro and above)
write_survey_sheets_headers
webhooks:write
Write a tab's header row (Pro and above)
create_survey_sheets_tab
webhooks:write
Create a tab in the connected Google Sheet (Pro and above)
send_survey_sheets_test_row
webhooks:write
Append a test row using the current column mapping (Pro and above)
backfill_survey_sheets
webhooks:write
Queue a backfill of past responses into the sheet (Pro and above)
Survey analysis, trends, distribution and shared dashboards
Crosstabs with significance and saved views, response-quality review, question concepts and trends, waves of email invitations, and cross-survey dashboard share links, scheduled reports and snapshots. Reads need surveys:read, changes need surveys:write. Sending, scans and reminders are queued.
Tool
Ability
Description
get_survey_analysis_questions
surveys:read
List the questions of a survey that can be cross-tabulated, with their categories, plus the inclusion policies. (Pro and above)
get_survey_crosstab
surveys:read
Run a crosstab of two questions: counts, valid denominator, row/column/total percentages, missing-value policy, multi-select caveats and (with statistics) two-sided comparisons with Holm correction and Fisher exact for sparse tables. Same numbers as the Analysis tab and its CSV. (Pro and above)
list_survey_analysis_views
surveys:read
List the saved crosstab views you may open on a survey (your private ones and the ones shared with the team). (Pro and above)
get_survey_analysis_view
surveys:read
Open one saved crosstab view; run=true also returns its computed result. (Pro and above)
create_survey_analysis_view
surveys:write
Save a crosstab configuration as a view. Private to you unless is_shared (needs edit rights on the survey). (Pro and above)
update_survey_analysis_view
surveys:write
Rename, share or change the configuration of a saved view. Only the author, or a member who may edit the survey, can. (Pro and above)
delete_survey_analysis_view
surveys:write
Delete a saved crosstab view. (Pro and above)
get_survey_quality
surveys:read
Read a survey's response-quality review: thresholds, flag counts by reason, last scan time, and the flagged or manually decided responses with the reasons and the audit trail. Flags only advise; nothing is deleted. (Pro and above)
scan_survey_quality
surveys:write
Queue a rebuild of a survey's response-quality flags (speeding, straight-lining, duplicates, gibberish). Returns at once; flags appear when the job finishes. Manual decisions are untouched. (Pro and above)
set_survey_quality_settings
surveys:write
Change the response-quality thresholds of a survey (speeding fraction, straight-lining and duplicate minimums, gibberish). Run a scan afterwards to apply them. (Pro and above)
decide_survey_response_quality
surveys:write
Record a reversible include, exclude or clear decision for one response. It is audited and the response is never deleted. (Pro and above)
list_survey_concepts
surveys:read
List the question concepts of a survey and of the workspace: stable meanings that let the same question be followed across survey versions and surveys. (Pro and above)
get_survey_trend
surveys:read
Per-period trend (week, month or quarter) of one concept: NPS, CSAT or choice distributions with sample size and response window. A changed scale is its own segment, never pooled. Pass compare_question and compare_value to compare a second cohort. (Pro and above)
map_survey_question_concept
surveys:write
Map a question (every version of it) onto an existing workspace concept, or onto a new one named by label. Refuses to mix different kinds of scale. (Pro and above)
list_survey_waves
surveys:read
List a survey's invitation waves with recipient, sent, reminded, completed, opted-out and bounced counts and the response rate. (Pro and above)
create_survey_wave
surveys:write
Create a draft invitation wave (scheduled, or event for event-triggered invitations). Add recipients, then launch it. (Pro and above)
update_survey_wave
surveys:write
Change a wave that is not closed. (Pro and above)
launch_survey_wave
surveys:write
Open a draft wave and queue its first invitations (needs a published survey and, for scheduled waves, at least one recipient). (Pro and above)
close_survey_wave
surveys:write
Close a wave: no more invitations or reminders go out and the link stops counting for it. (Pro and above)
send_survey_wave
surveys:write
Queue the invitations and the reminders that are due now for an open wave. Reminders go only to recipients who have not answered, under the wave's caps. (Pro and above)
list_survey_wave_schedules
surveys:read
List a survey's recurrence rules (weekly, monthly, quarterly or every N days) with status, next due time, waves created or skipped and the last outcome. (Pro and above)
create_survey_wave_schedule
surveys:write
Create a recurrence rule that starts a new invitation wave on a schedule, in a timezone, until an end date or a count. Recipients come from the previous wave; opted-out, bounced and recently-answered people are left out. Saving it sends nothing until automatic waves are switched on for the workspace. (Pro and above)
update_survey_wave_schedule
surveys:write
Change, pause or resume a recurrence rule. Resuming does not send slots that passed while it was paused. (Pro and above)
delete_survey_wave_schedule
surveys:write
Stop a recurrence rule and delete it on the queue. Waves it already created are kept. (Pro and above)
import_survey_invitations
surveys:write
Add recipients to a wave from text or CSV (an address per line, optional name after a comma or semicolon). Returns counts of added, duplicate, invalid and opted-out or undeliverable addresses; the last are recorded but never emailed. (Pro and above)
list_survey_invitations
surveys:read
List the recipients of a wave with status (invited, reminded, completed, opted_out, bounced), reminder counts and times. Addresses are masked unless you may edit the survey. (Pro and above)
trigger_survey_event_invitation
surveys:write
Invite one person because an event happened, subject to the open event wave, the opt-out list, the suppression window and the workspace frequency cap. The outcome says why a person was not invited. (Pro and above)
get_survey_dashboard_sharing
surveys:read
Read the share links (never their URLs), scheduled reports and recent snapshots of a cross-survey dashboard. (Pro and above)
create_survey_dashboard_share
surveys:write
Create a read-only share link for a dashboard. The URL is returned once; only its hash is stored. Revoking it stops it serving anything. (Pro and above)
revoke_survey_dashboard_share
surveys:write
Revoke a dashboard share link; it stops returning any data at once. (Pro and above)
create_survey_dashboard_report
surveys:write
Schedule a PDF or CSV report of a dashboard to workspace members. Each run captures an immutable snapshot, and recipients' access is re-checked at send time. (Pro and above)
update_survey_dashboard_report
surveys:write
Pause, resume or change the recipients of a scheduled dashboard report. (Pro and above)
capture_survey_dashboard_snapshot
surveys:write
Capture an immutable snapshot of a dashboard now, without emailing anyone. (Pro and above)
get_survey_dashboard_snapshot
surveys:read
Read a dashboard snapshot with its stored data and checksum, or with format=csv return the CSV rendered from it (pdf is returned base64 encoded). Files are rendered from the stored data and never recomputed. (Pro and above)
Polls
Tool
Ability
Description
archive_poll
polls:delete
Archive a poll (dashboard delete)
restore_poll
polls:write
Restore an archived poll
force_delete_poll
polls:delete
Permanently delete an archived poll (queued)
list_poll_versions
polls:read
List saved poll versions
restore_poll_version
polls:write
Restore a poll to an earlier version
list_poll_votes
polls:read
List individual poll votes with activity
export_poll_results
polls:read
Export raw poll votes as csv/json
move_poll
polls:write
Move a poll to another project of the workspace
Live poll events
Presenter sessions with a join code. polls:present is the presenter-only ability: it runs and moderates an event but cannot create events or add questions. A token with polls:write can do both.
Tool
Ability
Description
list_poll_events
polls:read
List live events with join code, join URL and screen URL
create_poll_event
polls:write
Create an event (Q&A, leaderboard, participant limit, language, names or anonymous, presentation theme)
get_poll_event
polls:read
Fetch an event with its presenter snapshot and state_version
add_poll_event_question
polls:write
Add a choice, quiz (one or more correct answers), rating, ranking, word cloud or open text question
update_poll_event_question
polls:write
Edit an existing question (send only what changes). Not while the question is open for voting; with responses, the format, number of options and answer key are locked
control_poll_event
polls:present or polls:write
Start, open, next, close, reveal, toggle leaderboard or Q&A, end. Needs expected_state_version; a stale value fails with revision_conflict and the latest snapshot
get_poll_event_results
polls:read
One question's results as a text table
list_poll_event_questions
polls:read
The Q&A moderation queue, including pending and hidden questions
moderate_poll_event_question
polls:present or polls:write
Approve, hide, answer or restore a question; conflict-checked and audited
get_poll_event_moderation_log
polls:read
The moderator audit log
export_poll_event
polls:read
Participants, publicly visible questions (never pending or hidden) or result tables
Feedback
Tool
Ability
Description
add_feedback_post_note
feedback:write
Add an internal team note to an idea (never shown publicly). (Pro and above)
approve_feedback_comment
feedback:moderate
Approve a pending comment in the moderation inbox. (Pro and above)
approve_feedback_post
feedback:moderate
Approve a pending idea in the moderation inbox. (Pro and above)
create_feedback_announcement
feedback:write
Create a changelog announcement (draft, or published right away with publish=true and feedback:publish). (Pro and above)
create_feedback_source
feedback:write
Connect an external feedback source and queue its first sync. (Pro and above)
create_feedback_status
feedback:write
Add a workflow status to a board. (Pro and above)
create_feedback_tag
feedback:write
Create a tag on a board. (Pro and above)
create_feedback_webhook
feedback:write
Add an outbound webhook to a board (default event feedback.post.created). (Pro and above)
delete_feedback_board
feedback:delete
Archive a feedback board (moves it to the archived tab; restore with restore_feedback_board). (Pro and above)
delete_feedback_post_note
feedback:write
Remove an internal note from an idea. (Pro and above)
delete_feedback_post
feedback:delete
Delete an idea with its votes, comments and notes (queued, audited). (Pro and above)
delete_feedback_status
feedback:write
Remove a workflow status; its ideas move to the first remaining status. A board keeps at least one. (Pro and above)
delete_feedback_tag
feedback:write
Delete a tag and detach it from every idea. (Pro and above)
delete_feedback_webhook
feedback:write
Remove an outbound webhook from a board. (Pro and above)
rotate_feedback_webhook_secret
feedback:write
Rotate a board webhook's signing secret with an overlap window; the new secret is shown once. (Pro and above)
get_feedback_hub_matching_metrics
feedback:read
How well Feedback Hub idea matching is working: thresholds, review queue, acceptance by method and confidence band, requests with no suggestion. (Pro and above)
get_feedback_board_sso
feedback:read
Read how customers sign in to a board with the owner's own OpenID Connect provider. The client secret is never returned. (Pro and above)
set_feedback_board_sso
feedback:write
Connect a board to an OpenID Connect provider so customers sign in with their company account; can be switched on once the provider is reachable and can be required. (Pro and above)
disconnect_feedback_board_sso
feedback:write
Remove the sign-in provider from a board on the queue and sign out the customers who used it. (Pro and above)
list_feedback_scoring_versions
feedback:read
List a board's prioritization formula versions and which one is active. (Pro and above)
list_feedback_prioritization
feedback:read
Rank a board's ideas by priority score with a range and confidence label; filter by segment, plan, lifecycle stage or tag to re-rank over only the matching accounts. Revenue and revenue-based scores need feedback:revenue. (Pro and above)
refresh_feedback_account_revenue
feedback:revenue
Queue a refresh of customer account revenue from CRM won deals and billing orders. Figures set by hand are never overwritten. (Pro and above)
set_feedback_scoring_formula
feedback:write
Make a prioritization formula (RICE, impact over effort, or weighted) the board's active one; a different formula is a new audited version, the same one changes nothing. A revenue weight also needs feedback:revenue. (Pro and above)
export_feedback_posts
feedback:read
Export a board's ideas as CSV text (public_id, title, body, status, votes, comments, moderation, created_at; up to 5000 rows). (Pro and above)
get_feedback_board
feedback:read
Fetch one feedback board with all its settings, design and pending-moderation counts (archived boards included). (Pro and above)
get_feedback_post
feedback:read
Fetch one idea with its status, tags and comments. With feedback:write or feedback:moderate it also returns internal notes, voters and similar ideas. (Pro and above)
get_feedback_roadmap
feedback:read
Read a board's roadmap: statuses in order with the approved ideas in each. (Pro and above)
list_feedback_announcements
feedback:read
List a board's changelog announcements (drafts and published). (Pro and above)
list_feedback_inbox
feedback:moderate
List ideas and comments waiting for moderation on a board. (Pro and above)
list_feedback_sources
feedback:read
List external feedback sources (NPS/survey JSON, Google Sheets, inline JSON) and the latest synced entries. (Pro and above)
list_feedback_statuses
feedback:read
List a board's workflow statuses in order. (Pro and above)
list_feedback_tags
feedback:read
List a board's tags. (Pro and above)
list_feedback_webhooks
feedback:read
List a board's outbound webhooks (signing secrets are never returned). (Pro and above)
merge_feedback_posts
feedback:write
Merge an idea into another idea on the same board (votes and comments move to the target; the source is closed). (Pro and above)
move_feedback_board
feedback:write
Move a feedback board to another project of the workspace. (Pro and above)
move_feedback_roadmap_card
feedback:write
Move an idea to another roadmap column (status) and optionally set its position; notifies followers of the status change. (Pro and above)
publish_feedback_board
feedback:publish
Publish a feedback board so its public portal goes live (also un-archives it). (Pro and above)
reject_feedback_comment
feedback:moderate
Reject a pending comment in the moderation inbox. (Pro and above)
reject_feedback_post
feedback:moderate
Reject a pending idea in the moderation inbox. (Pro and above)
reorder_feedback_statuses
feedback:write
Set the order of a board's workflow statuses. (Pro and above)
reply_to_feedback_post
feedback:write
Post a public team reply on an idea. (Pro and above)
restore_feedback_board
feedback:write
Restore an archived feedback board. (Pro and above)
set_feedback_board_design
feedback:write
Replace a feedback board's portal design (the same theme_v2 envelope the portal builder's Appearance tab saves: tokens, preset, device overrides). (Pro and above)
set_feedback_post_tags
feedback:write
Replace the tags on an idea (pass tag_ids or tag_slugs; an empty list clears them). (Pro and above)
sync_feedback_source
feedback:write
Queue a re-sync of an external feedback source. (Pro and above)
unpublish_feedback_board
feedback:publish
Take a feedback board's public portal offline (back to draft). (Pro and above)
update_feedback_announcement
feedback:write
Edit a changelog announcement; publish=true publishes it if still a draft (also needs feedback:publish). (Pro and above)
update_feedback_board
feedback:write
Update a feedback board's settings: name, description, slug, moderation and voting mode, portal copy and sign-in options, roadmap and changelog visibility, anonymous posting, email-for-vote, allowed embed origins, widget config, design (theme_v2) and hCaptcha (the secret is write-only). (Pro and above)
update_feedback_status
feedback:write
Edit a workflow status (name, colour, roadmap visibility, terminal flag, position). (Pro and above)
update_feedback_tag
feedback:write
Rename or recolour a tag. (Pro and above)
Response Desk
Tool
Ability
Description
get_desk_thread
desk:read
Open one thread with messages, customer, history, macros (Scale and above)
Bulk assign/resolve/spam/tag/priority/label/unlabel threads (Scale and above)
reply_desk_thread
desk:reply
Queue an email reply or add an internal note (a note can mentions teammates, or name them with @Full Name, to notify them). An email reply needs expected_revision (the thread revision from get_desk_thread); without it, or when stale, the reply is refused with revision_required or revision_conflict and your text is kept as a draft (Scale and above)
get_desk_analytics
desk:read
Desk analytics report (Scale and above)
get_desk_settings
desk:read
Read all Desk settings (no secrets) (Scale and above)
get_desk_email_health
desk:read
Check email setup: forwarding, sender DNS and 30-day deliverability, with fix steps (Scale and above)
get_desk_sla_settings
desk:read
Read SLA policies, holidays, escalation rules, queues and your availability (Scale and above)
save_desk_sla_policy
desk:admin
Create or update an SLA policy with first-reply, next-reply and resolution targets (Scale and above)
delete_desk_sla_policy
desk:admin
Delete an SLA policy (Scale and above)
set_desk_holidays
desk:admin
Set the holiday calendar business-hour SLA clocks skip (Scale and above)
save_desk_escalation_rule
desk:admin
Create or update an escalation rule for at-risk or breached clocks (Scale and above)
delete_desk_escalation_rule
desk:admin
Delete an escalation rule (Scale and above)
save_desk_queue
desk:admin
Create or update an assignment queue (round-robin or least loaded) (Scale and above)
delete_desk_queue
desk:admin
Delete an assignment queue (Scale and above)
set_desk_availability
desk:reply
Set whether you take new conversations, optionally until a time (Scale and above)
get_desk_report
desk:read
Performance report with business and calendar durations, reopens and CSAT; JSON or CSV (Scale and above)
import_desk_export
desk:admin
Dry-run or import a Help Scout, Zendesk or Freshdesk export with assignee mapping (Scale and above)
get_desk_import_run
desk:read
Read an import run: progress, counts and what did not carry over (Scale and above)
check_desk_inbound_address
desk:read
Check project inbound handle availability (Scale and above)
update_desk_inbound_address
desk:admin
Rename project inbound address handle (Scale and above)
set_desk_response_goal
desk:admin
Set/disable first-reply goal (Scale and above)
set_desk_business_hours
desk:admin
Save open hours (Scale and above)
set_desk_sources
desk:admin
Choose sources that open conversations (Scale and above)
set_desk_reply_settings
desk:admin
Reply email greeting/signature/sender/footer (Scale and above)
send_desk_reply_test
desk:admin
Send yourself a test reply email (Scale and above)
set_desk_weekly_report
desk:admin
Weekly report opt-in for token owner (Scale and above)
create_desk_email_channel
desk:admin
Add email channel from Postmark sender (Scale and above)
update_desk_email_channel
desk:admin
Update email channel (Scale and above)
delete_desk_email_channel
desk:admin
Remove email channel (Scale and above)
follow_desk_thread
desk:assign
Follow a thread (or add a teammate as follower) to be told when it moves (Scale and above)
unfollow_desk_thread
desk:assign
Stop following a thread (Scale and above)
get_desk_live_board
desk:read
The live view: open, unattended, unassigned, waiting and overdue conversations plus each teammate's availability and load (Scale and above)
list_desk_labels
desk:read
List Desk labels with colour and how many conversations carry each (Scale and above)
create_desk_label
desk:admin
Create a coloured Desk label (Scale and above)
update_desk_label
desk:admin
Rename or recolour a Desk label (Scale and above)
delete_desk_label
desk:admin
Delete a Desk label; it is removed from every conversation in the background (Scale and above)
list_desk_macros
desk:read
List saved replies with short code, actions and the placeholders you can use (Scale and above)
run_desk_macro
desk:assign / desk:reply
Run a saved reply on a thread: its actions are applied and it returns the text with placeholders filled in; the text is only sent when the macro has the send action (Scale and above)
list_desk_saved_views
desk:read
List your saved Desk views and the ones your team shares, with the filters each applies (Scale and above)
save_desk_saved_view
desk:reply
Save a Desk list view (name, filters, optionally shared with the team), or change one of yours (Scale and above)
delete_desk_saved_view
desk:reply
Delete one of your saved Desk views (Scale and above)
create_desk_macro
desk:admin
Create saved reply with an optional short code and actions (Scale and above)
update_desk_macro
desk:admin
Update saved reply, short code or actions (Scale and above)
delete_desk_macro
desk:admin
Delete saved reply (Scale and above)
list_desk_automation_rules
desk:read
List Desk automation rules with the fields and operators a condition can use (Scale and above)
save_desk_automation_rule
desk:admin
Create or change a Desk automation rule: event, conditions, actions, delay (Scale and above)
delete_desk_automation_rule
desk:admin
Delete a Desk automation rule (Scale and above)
list_desk_automation_runs
desk:read
The automation log: what ran on which conversation, what it did or skipped (Scale and above)
set_desk_auto_resolve
desk:admin
Resolve quiet conversations after N days, with an optional closing message and label (Scale and above)
get_desk_notification_preferences
desk:read
Which Desk events reach the token owner by email and by push (Scale and above)
set_desk_notification_preferences
desk:reply
Choose which Desk events reach the token owner by email and by push (Scale and above)
list_desk_attributes
desk:read
List Desk custom attributes (key, scope, type, choices) (Scale and above)
save_desk_attribute
desk:admin
Create or change a Desk custom attribute (Scale and above)
delete_desk_attribute
desk:admin
Delete a Desk custom attribute and its stored values (Scale and above)
list_desk_webhooks
desk:read
List Desk webhooks and the events they can listen for (Scale and above)
save_desk_webhook
desk:admin
Create or change a Desk webhook; the signing secret is returned once on creation (Scale and above)
delete_desk_webhook
desk:admin
Delete a Desk webhook (Scale and above)
rotate_desk_webhook_secret
desk:admin
Replace a Desk webhook signing secret with an overlap window (Scale and above)
list_desk_webhook_deliveries
desk:read
The Desk webhook delivery log (Scale and above)
replay_desk_webhook_delivery
desk:admin
Send a logged Desk webhook delivery again (Scale and above)
merge_desk_threads
desk:assign
Merge a conversation into another one with the same customer; it cannot be undone (Scale and above)
create_desk_routing_rule
desk:admin
Create routing rule, with sender, subject and text conditions (Scale and above)
update_desk_routing_rule
desk:admin
Change or pause a routing rule (Scale and above)
delete_desk_routing_rule
desk:admin
Delete routing rule (Scale and above)
connect_desk_postmark
desk:admin
Connect Postmark server token, sync senders (Scale and above)
sync_desk_postmark
desk:admin
Refresh Postmark senders (Scale and above)
send_desk_postmark_test
desk:admin
Send Postmark test email to yourself (Scale and above)
disconnect_desk_postmark
desk:admin
Disconnect Postmark (Scale and above)
connect_desk_resend
desk:admin
Connect your Resend API key and sending address for Desk replies (Scale and above)
send_desk_resend_test
desk:admin
Send a Resend test email to yourself; confirms the sending domain (Scale and above)
disconnect_desk_resend
desk:admin
Disconnect Resend and delete the stored key (Scale and above)
Contacts
Tool
Ability
Description
add_contact_note
contacts:write
Add an internal note to a contact. (Pro and above)
delete_contact_note
contacts:write
Delete a contact note (queued). (Pro and above)
record_contact_consent
contacts:write
Record a marketing-email consent decision for a contact. (Pro and above)
list_contact_duplicates
contacts:read
List groups of look-alike contacts. (Pro and above)
merge_contacts
contacts:write
Queue a merge of duplicate contacts into a primary contact. (Pro and above)
undo_contact_merge
contacts:write
Undo a completed contact merge (queued). (Pro and above)
Segments
Tool
Ability
Description
preview_segment
segments:read
Preview who a filter tree would match before saving. (Pro and above)
Delivery
Tool
Ability
Description
get_delivery_hub
displays:read
In-app survey overview: surveys, SDK keys, install snippet, frequency cap. (Pro and above)
set_survey_frequency_cap
surveys:write
Set or clear the team-wide in-app survey frequency cap. (Pro and above)
Funnels
Tool
Ability
Description
restore_funnel
funnels:delete
Restore a trashed funnel. (Pro and above)
force_delete_funnel
funnels:delete
Permanently delete a trashed funnel in the background. (Pro and above)
move_funnel
funnels:write
Move a funnel to another project of the workspace. (Pro and above)
list_funnel_versions
funnels:read
List saved funnel versions (History panel). (Pro and above)
restore_funnel_version
funnels:write
Restore a funnel to a saved version as a new version. (Pro and above)
list_funnel_starter_templates
funnels:read
List the new-funnel starter templates. (Pro and above)
get_funnel_auto_purge
funnels:read
Read funnel auto-purge setting (Pro and above)
set_funnel_auto_purge
funnels:write
Set/clear funnel auto-purge window (Pro and above)
get_funnel_custom_domain
funnels:read
Read custom domain, prefix, cert status and the DNS records to publish, including the ownership record (Pro and above)
set_funnel_custom_domain
funnels:write
Set/clear funnel custom domain and path prefix (Pro and above)
verify_funnel_custom_domain
funnels:write
Check the DNS ownership record of a funnel's custom domain; queues the certificate once it passes (Pro and above)
retry_funnel_custom_domain
funnels:write
Re-queue custom-domain certificate issuance (Pro and above)
get_funnel_embed
funnels:read
Embed snippets, URLs and allowed origins (Pro and above)
list_funnel_integrations
funnels:read
List funnel integrations and vendor catalogue (Pro and above)
create_funnel_integration
funnels:write
Connect an integration with credentials (Pro and above)
update_funnel_integration
funnels:write
Update/enable an integration (Pro and above)
delete_funnel_integration
funnels:write
Disconnect an integration (Pro and above)
list_funnel_integration_dispatches
funnels:read
Integration delivery log (Pro and above)
replay_funnel_integration_dispatch
funnels:write
Queue replay of an integration delivery (Pro and above)
get_funnel_integration_oauth_url
funnels:write
OAuth start URL for HighLevel/HubSpot/Salesforce/Zoho (Pro and above)
list_funnel_pixel_servers
funnels:read
Server-side pixels, catalogue, recent dispatches (Pro and above)
create_funnel_pixel_server
funnels:write
Add a server-side pixel (Pro and above)
update_funnel_pixel_server
funnels:write
Update/enable a server-side pixel (Pro and above)
delete_funnel_pixel_server
funnels:write
Remove a server-side pixel (Pro and above)
test_fire_funnel_pixel_server
funnels:write
Send a test conversion through a pixel (Pro and above)
get_funnel_smtp
funnels:read
Read redacted funnel SMTP override (Pro and above)
set_funnel_smtp
funnels:write
Save funnel SMTP override (Pro and above)
delete_funnel_smtp
funnels:write
Clear funnel SMTP override (Pro and above)
test_funnel_smtp
funnels:write
Send SMTP test email to token owner (Pro and above)
list_funnel_team_fonts
funnels:read
List team fonts (Pro and above)
upload_funnel_team_font
funnels:write
Upload team woff2 font via url or base64 (Pro and above)
list_funnel_submissions
funnels:read
List funnel submissions with inbox filters (Pro and above)
get_funnel_submission
funnels:read
Get one funnel submission with file metadata (Pro and above)
update_funnel_submission
funnels:write
Set submission status / spam reason (Pro and above)
delete_funnel_submission
funnels:write
Queue deletion of a funnel submission (Pro and above)
bulk_funnel_submissions
funnels:write
Bulk delete / mark spam / mark received with per-row authorize (Pro and above)
export_funnel_submissions
funnels:export
Export submissions as JSON or CSV string, paged (Pro and above)
get_funnel_submission_file
funnels:read
Signed download URL for an uploaded file (Pro and above)
get_funnel_submission_pdf
funnels:read
Submission PDF as base64 (5 MB cap) (Pro and above)
reveal_funnel_sensitive_field
funnels:reveal
Password-gated, rate-limited, audited sensitive field reveal (Pro and above)
list_funnel_webhooks
webhooks:read
List funnel webhooks, provider catalogue, sheets reconnect URLs (Pro and above)
get_funnel_webhook
webhooks:read
Get webhook with scrubbed config, mapping fields, sheets connect URL (Pro and above)
Update webhook settings and config (Pro and above)
delete_funnel_webhook
webhooks:write
Delete a funnel webhook (Pro and above)
rotate_funnel_webhook_secret
webhooks:write
Rotate a funnel webhook's signing secret with an overlap window; the new secret is shown once (Pro and above)
list_funnel_webhook_deliveries
webhooks:read
List webhook deliveries with status/date filters (Pro and above)
replay_funnel_webhook_delivery
webhooks:write
Queue a webhook delivery replay (Pro and above)
list_funnel_sheets_tabs
webhooks:write
List tabs of the connected Google Sheet (Pro and above)
get_funnel_sheets_header_row
webhooks:write
Read a tab header row (Pro and above)
create_funnel_sheets_tab
webhooks:write
Create a sheet tab (Pro and above)
write_funnel_sheets_headers
webhooks:write
Write a tab header row (Pro and above)
test_funnel_sheets_row
webhooks:write
Append a test row (Pro and above)
backfill_funnel_sheets
webhooks:write
Queue a sheets backfill (Pro and above)
list_funnel_collaborators
funnels:read
List team access + collaborators (Pro and above)
invite_funnel_collaborator
funnels:write
Invite a collaborator (queued mail, audit entry) (Pro and above)
update_funnel_collaborator_role
funnels:write
Change a collaborator role (Pro and above)
remove_funnel_collaborator
funnels:write
Remove a collaborator (Pro and above)
list_funnel_audit_log
funnels:read
Audit log with event filter, json or csv export (Pro and above)
list_funnel_languages
funnels:read
List funnel languages (Pro and above)
add_funnel_language
funnels:write
Add a language (Pro and above)
update_funnel_language
funnels:write
Update alias/enabled/default (Pro and above)
delete_funnel_language
funnels:write
Delete a non-default language (Pro and above)
translate_funnel_language
funnels:write
Queue AI translation (returns a locked response without AI) (Pro and above)
generate_funnel_with_ai
funnels:write
Queue AI funnel generation (credit gate, rate limit) (Pro and above)
get_funnel_ai_generation
funnels:read
Poll an AI generation or list recent ones (Pro and above)
cancel_funnel_ai_generation
funnels:write
Cancel an in-flight AI generation (Pro and above)
list_funnel_ad_copy
funnels:read
List ad-copy variants + platform limits (Pro and above)
generate_funnel_ad_copy
funnels:write
Queue ad-copy batch generation (Pro and above)
regenerate_funnel_ad_copy_variant
funnels:write
Queue regeneration of one variant (Pro and above)
mark_funnel_ad_copy_best
funnels:write
Mark/unmark best variant (Pro and above)
delete_funnel_ad_copy_variant
funnels:write
Archive an ad-copy variant (Pro and above)
export_funnel_ad_copy
funnels:read
Per-platform ad-copy CSV (Pro and above)
get_funnel_meta_launch
funnels:read
Meta launch readiness + recent attempts (Pro and above)
launch_funnel_meta_campaign
funnels:publish
Queue a paused Meta campaign launch (Pro and above)
retry_funnel_meta_launch
funnels:publish
Retry a failed Meta launch from its stage (Pro and above)
Links
Tool
Ability
Description
restore_link
links:write
Restore a link from the trash
move_link
links:write
Move a link to another project
list_link_missed_slugs
links:read
Most requested unknown short links
update_link_qr_options
links:write
Save QR styling defaults of a link
get_link_qr
links:read
Render a link QR code as data
get_link_analytics
links:analytics:read
Link click analytics (counters, views, heatmap, metrics, events, locations)
get_link_outcomes
links:analytics:read
Raw, human and estimated unique clicks, verified and unattributed conversions by type, and value per currency
get_link_destinations
links:read
Destination experiment: clicks and conversions per destination, with a chi-squared significance readout
set_link_destinations
links:write
Replace the destination experiment (weights, schedule, active flags)
set_link_attribution
links:write
Choose whether the redirect appends the click id and set the attribution lookback window
list_branded_domains
links:read
List branded short hosts with DNS records
create_branded_domain
links:write
Add a branded short host
check_branded_domain
links:write
Queue a DNS/HTTPS re-check
verify_branded_domain_dns
links:write
Verify branded host DNS
verify_branded_domain_https
links:write
Verify branded host HTTPS routing
delete_branded_domain
links:write
Remove a branded short host
update_branded_domain
links:write
Record the domain registration expiry date that drives expiry alerts
request_link_review
links:write
Ask for a human review of a suspended link
set_link_app_association
links:write
Publish an iOS or Android app association with allowed app paths on a branded host
verify_link_app_association
links:write
Fetch the association file back from the live host and report its status
delete_link_app_association
links:write
Remove an app association from a branded host
Bio pages
Tool
Ability
Description
restore_bio_page
bio:write
Restore a bio page from the trash
move_bio_page
bio:write
Move a bio page to another project in the workspace
update_bio_qr_options
bio:write
Save default QR styling of a bio page
get_bio_qr_code
bio:read
Render the bio page QR code as data (svg or base64)
fetch_bio_favicon
bio:write
Fetch a website favicon (SSRF-guarded) and use it for the page
preview_bio_import
bio:read
Preview importing a CSV or JSON link-list export; embeds and unsupported blocks are flagged, nothing is written
get_bio_instagram
bio:read
Instagram comments on a bio page: account status, rules and the latest comments with the reason a reply was sent or blocked (awaiting provider approval, off until enabled)
save_bio_instagram_rule
bio:write
Create or update an Instagram keyword rule that sends one private reply per matching comment (awaiting provider approval, off until enabled)
refund_bio_order
bio:write
Refund a Bio order in whole or in part; the order updates when the payment provider confirms
list_bio_courses
bio:read
List the workspace's Bio courses (free or paid, price, status, lesson counts) without their lessons
get_bio_course
bio:read
One course with its whole curriculum, the pages that sell it and, on request, its members with access state and progress
save_bio_course
bio:write
Create or update a course and, when modules is sent, replace its whole curriculum (lessons left out are deleted with their files)
publish_bio_course
bio:write
Put a course on sale, or take it off sale (existing members keep access)
place_bio_course
bio:write
Add a course to a Bio Page as a sales block
delete_bio_course
bio:write
Permanently delete a course; a queued job removes lessons, files, members and sales blocks
set_bio_course_access
bio:write
Revoke, restore or re-send one member's access link
import_bio_links
bio:write
Import an authorized link-list export into a bio page (appended in order; hidden entries import switched off)
update_bio_block
bio:write
Edit one bio block: config patch, visibility, gating, tab
get_bio_document
bio:read
Read the full builder document of a bio page
get_bio_builder_context
bio:read
Plan gates, presets, linkable links/forms/projects for the Bio builder
upload_bio_image
bio:write
Upload an image (url/base64) for avatar, cover, blocks
upload_bio_document_file
bio:write
Upload a PDF (url/base64) for a document block
upload_bio_product_file
bio:write
Upload a private product file (url/base64) for product/shop blocks
delete_bio_file
bio:write
Delete an uploaded document or product file by key
export_bio_audience
bio:audience:export
Queue a CSV export of the Bio audience (Pro and above)
get_bio_audience_export
bio:audience:export
Poll a Bio audience export, optionally returning the CSV inline (Pro and above)
list_bio_audience_sync_targets
bio:audience:export
List email-tool integrations the audience can sync to (Pro and above)
sync_bio_audience
bio:audience:export
Queue an audience sync to an email-tool integration (Pro and above)
get_bio_payments
bio:read
Bio Stripe payout status (optional refresh from Stripe)
start_bio_stripe_connect
bio:write
Return the hosted Stripe payout onboarding URL (Pro and above)
get_bio_analytics
bio:analytics:read
Bio page counters and views series (retention clamped)
Automations
Tool
Ability
Description
get_automation_config
automations:read
Trigger types, action keys and config schema per owner type
list_automation_templates
automations:read
Ready-made automation templates per owner type; with target_type: "workspace" the workspace library, with what each needs and whether it can be installed now
get_automation_template
automations:read
Preview one workspace library template: trigger, steps in plain words, the settings it takes, and whether the plan can install it
install_automation_template
automations:write
Install a workspace library template as a workspace automation, switched off unless activate is true; same validation and plan gates as create_automation
test_automation
automations:run
Dry-run an automation definition against a sample payload
Bookings
Tool
Ability
Description
list_booking_pages
bookings:read
List booking pages (active/trash) with counts and share links (Pro and above)
get_booking_page
bookings:read
Get one booking page with all settings, links, embed snippets (Pro and above)
get_booking_analytics
bookings:read
Last-30-day booking totals and where bookings came from (sources, campaigns, click-id totals) (Pro and above)
record_booking_crm_outcome
bookings:write
Report a CRM stage or qualified/won/lost for a booking (appointment_id); idempotent per source_fact_id(Pro and above)
record_booking_revenue_adjustment
bookings:write
Record a refund or dispute against a won booking deal; idempotent per source_fact_id(Pro and above)
list_booking_appointments
bookings:read
List a page's upcoming/past bookings or team-wide upcoming (Pro and above)
get_booking_design
bookings:read
Design Studio state: host name, headline, avatar, theme envelope, presets (Pro and above)
list_booking_calendars
bookings:read
Connected calendars, Zoom status and browser connect links (no credentials) (Pro and above)
create_booking_page
bookings:write
Create an unpublished booking page (Pro and above)
update_booking_page
bookings:write
Update scheduling settings (partial, same validation as editor) (Pro and above)
update_booking_routing
bookings:write
Set the scheduling mode, hosts, organizer, rotating pools, caps and routing rules (Pro and above)
retry_booking_calendar_sync
bookings:write
Queue the calendar write again for a booking whose event is missing (Pro and above)
update_booking_slug
bookings:write
Rename the public slug (Pro and above)
update_booking_design
bookings:write
Update host name, headline and theme envelope (Pro and above)
set_booking_host_avatar
bookings:write
Set host photo from url or base64 (Pro and above)
remove_booking_host_avatar
bookings:write
Remove host photo (Pro and above)
rotate_booking_private_link
bookings:write
Create/rotate private link (Pro and above)
move_booking_page
bookings:write
Move page to another project of the same team (Pro and above)
approve_booking_appointment
bookings:write
Approve a pending booking (Pro and above)
decline_booking_appointment
bookings:write
Decline a pending booking (Pro and above)
cancel_booking_appointment
bookings:write
Cancel a booking as host; a paid booking is refunded in full, deposit and balance (Pro and above)
request_booking_balance
bookings:write
Email the invitee a secure checkout link for what is left of a deposit booking (Pro and above)
refund_booking_payment
bookings:write
Refund a booking payment in whole or in part, deposit first; also works on a cancelled booking (Pro and above)
set_booking_appointment_no_show
bookings:write
Mark/clear no-show (Pro and above)
list_booking_resources
bookings:read
List rooms, locations, equipment and pools that pages can share (Pro and above)
save_booking_resource
bookings:write
Create or change a room, location or pool of interchangeable rooms, with capacity and weekly hours (Pro and above)
delete_booking_resource
bookings:delete
Delete a resource. Queued; refused while it hosts upcoming bookings (Pro and above)
set_booking_page_resource
bookings:write
Point a booking page at a resource, or clear it (Pro and above)
add_booking_ical_calendar
bookings:write
Add a read-only iCal feed (Pro and above)
remove_booking_calendar
bookings:write
Disconnect a calendar (Pro and above)
disconnect_booking_zoom
bookings:write
Disconnect Zoom (Pro and above)
publish_booking_page
bookings:publish
Publish a booking page (Pro and above)
unpublish_booking_page
bookings:publish
Unpublish a booking page (Pro and above)
delete_booking_page
bookings:delete
Move a booking page to trash (Pro and above)
restore_booking_page
bookings:delete
Restore from trash (Pro and above)
force_delete_booking_page
bookings:delete
Queue permanent deletion of a trashed page (Pro and above)
Orders
Tool
Ability
Description
list_orders
orders:read
List ledger orders with status, source, subject, date and customer filters
get_order
orders:read
One order with line items, field ids, refund and dispute facts and the event timeline
get_orders_summary
orders:read
Gross, refunded, disputed and net totals of paid orders per currency
refund_order
orders:refund
Ask the payment provider to refund a form or funnel order, in whole or in part. Money moves and cannot be taken back. Reported as pending until the provider confirms; a repeated request returns the refund already asked for
Knowledge
Tool
Ability
Description
list_knowledge_articles
knowledge:read
List articles with collection/status/text filters and totals (Scale and above)
get_knowledge_article
knowledge:read
Get one article with body, stats and public URL (Scale and above)
create_knowledge_article
knowledge:write
Create an article (draft or published) with optional body, slug, visibility (Scale and above)
update_knowledge_article
knowledge:write
Update, publish or unpublish an article (Scale and above)
delete_knowledge_article
knowledge:write
Queue an article delete (Scale and above)
search_knowledge_articles
knowledge:read
Search articles for the reply picker (Scale and above)
suggest_knowledge_articles
knowledge:read
Suggest articles for a desk thread (Scale and above)
mark_knowledge_article_inserted
knowledge:write
Count an article inserted into a reply (Scale and above)
list_unanswered_questions
knowledge:read
Desk questions no article answers (Scale and above)
list_knowledge_collections
knowledge:read
List collections with article counts (Scale and above)
create_knowledge_collection
knowledge:write
Create a collection (Scale and above)
update_knowledge_collection
knowledge:write
Rename, describe or reorder a collection (Scale and above)
delete_knowledge_collection
knowledge:write
Queue a collection delete (articles kept) (Scale and above)
get_help_center_settings
knowledge:read
Read help center settings and appearance (Scale and above)
update_help_center_settings
knowledge:write
Update help center address, availability, appearance, CSS (Scale and above)
rotate_help_widget_secret
knowledge:write
Rotate the widget identity secret (shown once; the previous one verifies for the overlap window) or pass end_overlap(Scale and above)
list_help_centers
knowledge:read
List the team's help centers and the plan limit (Scale and above)
create_help_center
knowledge:write
Create another help center, within the plan limit (Scale and above)
delete_help_center
knowledge:write
Queue a help center delete with its articles and collections (Scale and above)
list_knowledge_article_revisions
knowledge:read
Published versions, approval state, owner, schedule and last link check (Scale and above)
rollback_knowledge_article
knowledge:write
Restore an earlier published version; the address does not change (Scale and above)
review_knowledge_article
knowledge:write
Request, approve or reject a review (Scale and above)
check_knowledge_article_links
knowledge:write
Queue a broken-link check (Scale and above)
list_knowledge_article_translations
knowledge:read
Languages with missing, draft, approved or stale state (Scale and above)
save_knowledge_translation
knowledge:write
Write your own translation (Scale and above)
approve_knowledge_translation
knowledge:write
Approve a saved translation (Scale and above)
translate_knowledge_article
knowledge:write
Queue an AI draft translation (Scale and above)
resolve_knowledge_translation_draft
knowledge:write
Accept or discard an AI proposal (Scale and above)
list_knowledge_customer_groups
knowledge:read
Customer groups, collection audiences and access links (Scale and above)
create_knowledge_customer_group
knowledge:write
Create a customer group (Scale and above)
update_knowledge_customer_group
knowledge:write
Rename a group or change its key (Scale and above)
delete_knowledge_customer_group
knowledge:write
End a group's access at once and queue its delete (Scale and above)
add_knowledge_group_member
knowledge:write
Add a member by email, domain or customer id (Scale and above)
remove_knowledge_group_member
knowledge:write
Remove a member (Scale and above)
set_knowledge_collection_access
knowledge:write
Set a collection's audience, groups and search engine visibility (Scale and above)
create_knowledge_access_link
knowledge:write
Create a signed customer access link; the address is shown once (Scale and above)
revoke_knowledge_access_link
knowledge:write
Revoke an access link (Scale and above)
get_knowledge_insights
knowledge:read
Search, helpfulness, AI answer and contact figures with denominators (Scale and above)
list_knowledge_search_gaps
knowledge:read
Searches that found no article (Scale and above)
ask_knowledge_question
knowledge:write
Ask the AI answer a question as an anonymous reader (Scale and above)
get_knowledge_answer
knowledge:read
Read an AI answer and its sources (Scale and above)
create_knowledge_import
knowledge:write
Import Markdown, CSV or a helpdesk export as drafts (Scale and above)
get_knowledge_import
knowledge:read
Import status and flagged items (Scale and above)
create_knowledge_export
knowledge:write
Start a content export (Scale and above)
get_knowledge_export
knowledge:read
Export status and signed download link (Scale and above)
Support
Tool
Ability
Description
contact_support
support:write
Send an in-app support message
Billing
Tool
Ability
Description
list_billing_plans
billing:read
Plans, price ids, current plan and credit packs
get_billing_overview
billing:read
Billing page data (owner only)
get_ai_credits
billing:read
AI credit balance and packs
list_invoices
billing:read
Recent invoices (owner only)
get_invoice
billing:read
One invoice with hosted and PDF links (owner only)
get_billing_portal_url
billing:read
Hosted billing portal URL (owner only)
subscribe_to_plan
billing:write
Subscribe (checkout URL) or switch plan, with downgrade guard
cancel_subscription
billing:write
Cancel at period end; requires confirm: true
resume_subscription
billing:write
Resume a subscription in its grace period
apply_billing_coupon
billing:write
Apply a promotion code or coupon
purchase_ai_credit_pack
billing:write
Start an AI credit pack checkout and return its URL
AI Insights
Tool
Ability
Description
regenerate_insight_themes
insights:write
Regenerate the AI written-answer themes report (plan/credit gated, soft locked response)
export_ai_insights
insights:read
Export AI insights as json or csv text (Pro and above)
AI generation
Tool
Ability
Description
generate_form
forms:write
Start an AI form generation (spends a credit)
get_form_generation_status
forms:read
Poll an AI form generation
cancel_form_generation
forms:write
Cancel an AI form generation
Guided create
Tool
Ability
Description
list_wizard_recipes
forms:read or surveys:read or funnels:read or bio:read or links:read
Guided-setup recipes with questions and plan locks
create_from_wizard
forms:write or surveys:write or funnels:write or bio:write or links:write or bookings:write
Build a product from a recipe and answers
Builder assets
Tool
Ability
Description
upload_builder_asset
forms:write or surveys:write or funnels:write or polls:write or bio:write
Upload an image by URL or base64, returns a public URL
preview_theme
forms:read or surveys:read or funnels:read or polls:read or bio:read
Resolve a theme_v2 into CSS and tokens without saving
Account
Tool
Ability
Description
get_feature_onboarding
account:read
Setup guide catalogue and progress
get_sample_workspace
account:read
How many example rows the workspace holds per product
add_sample_workspace
account:write
Add example data to every product the plan includes, flagged sample (owner or administrator, runs in the background)
remove_sample_workspace
account:write
Remove all sample data through the queued delete jobs (owner or administrator)
update_feature_onboarding
account:write
Mark a walkthrough seen/step/complete/dismiss/reset
get_profile
account:read
Read-only profile, 2FA status, workspaces
get_operation
any valid token
Status of background work another tool accepted (queued: true answers carry an operation.id); poll until terminal
get_dashboard
account:read
Workspace home sections (stats, KPIs, work queue, recent, tasks)
search_workspace
account:read
Cmd+K search across products by name
Projects
Tool
Ability
Description
list_projects
projects:read
List projects (active/archived) with contents, counts, activity
get_project
projects:read
One project with forms, surveys, funnels, sub-account assignment, inbound address
create_project
projects:write
Create a project (policy create, slug generation)
update_project
projects:write
Rename a project / change slug
archive_project
projects:delete
Archive a project
restore_project
projects:write
Restore an archived project
delete_project
projects:delete
Queue permanent deletion of an archived project (confirm slug)
Invite by email with role and optional project limit (queued mail)
resend_team_invitation
members:write
Resend an invitation (cooldown)
cancel_team_invitation
members:write
Cancel an invitation
update_team_member_role
members:write
Change a member role (owner, team_rbac plan)
remove_team_member
members:write
Remove a member (owner; not self)
set_team_member_project_access
members:write
All / selected project access for a member
list_approval_requests
approvals:read
Approval requests by status
approve_approval_request
approvals:write
Approve a request (publish form / delete submission)
reject_approval_request
approvals:write
Reject a request
Agency
Tool
Ability
Description
add_client_report_recipients
agency:write
Add outside email addresses to a client report schedule; each confirms by email first (Team and above)
add_portal_note
agency:write
Add an internal note to a funnel submission on the portal (Team and above)
approve_client_deployment
approvals:write
Approve a rollout staged in this client workspace so it goes live; client admins only
archive_portal_client
agency:write
Archive a portal client: pending links stop working and a joined client loses access (queued) (Team and above)
assign_project_to_sub_account
agency:write
Give a sub-account access to one of the agency's projects, or omit sub_account_id to unassign the project (Team and above)
build_bundle_version
agency:write
Build a draft bundle version from the agency's own assets (Team and above)
bulk_portal_submissions
agency:write
Apply a bulk action to up to 500 portal submissions: move_to_stage, assign (records the assignee in the activity log), tag, or export (retur (Team and above)
check_portal_domain
agency:write
Queue a fresh DNS lookup for the agency portal custom domain; read the result with get_portal_domain (Team and above)
clear_portal_funnel_stages
agency:write
Remove the deal stage override of one funnel so it follows the team default again (Team and above)
create_client_report_schedule
agency:write
Schedule a weekly or monthly report for one client, to members and confirmed outside addresses (Team and above)
create_sub_account
agency:write
Create a client workspace (sub-account) under the agency (Team and above)
delete_portal_note
agency:write
Delete a note from a funnel submission on the portal (Team and above)
delete_sub_account
agency:write
Delete a client workspace (sub-account) (Team and above)
deploy_bundle
agency:write
Roll a published bundle version out to one client as drafts, with automation and rebind options (Team and above)
get_agency_overview
agency:read
The consolidated overview of the clients you hold a grant for (Team and above)
get_agency_settings
agency:read
Read the workspace's agency state: whether agency mode is on, whether the plan allows it, whether this workspace is itself a client workspac
get_bundle
agency:read
Read one bundle with its versions and rollouts (Team and above)
get_bundle_deployment
agency:read
Read one rollout, including the slots that can still be rebound (Team and above)
get_client_report
agency:read
Key numbers and AI generation use for one client over a period (Team and above)
get_portal_board
agency:read
Read the kanban board of one funnel in the agency portal: its stages, the count per stage and up to 500 recent non-spam submission cards (na (Team and above)
get_portal_branding
agency:read
Read the agency portal branding (name, logo URL, colour/font/radius tokens) and the legacy portal domain (Team and above)
get_portal_domain
agency:read
Read the agency portal custom domain: the domain, certificate status, the DNS record to publish and the last DNS check result (Team and above)
go_live_bundle_deployment
agency:write
Publish a staged rollout in the client workspace (queued) (Team and above)
invite_portal_client
agency:write
Invite a client to the agency portal by email (Team and above)
list_bundle_deployments
agency:read
List rollouts for the clients you hold a grant for (Team and above)
list_bundles
agency:read
List the agency's reusable workspace bundles (Team and above)
list_client_approvals
approvals:read
List the rollouts staged in this client workspace and waiting for a decision
list_client_report_schedules
agency:read
List scheduled client reports with the confirmation state of outside addresses (Team and above)
list_portal_clients
agency:read
List the portal clients (invites) with their lifecycle (invited, active, paused, archived), plus the funnels and projects that can be shared (Team and above)
list_portal_funnels
agency:read
List the funnels shown in the agency portal (the board picker) with their submission counts, plus the portal branding (Team and above)
list_portal_notes
agency:read
Read the notes and the activity log of one funnel submission on the portal (latest 200 each) (Team and above)
list_portal_stages
agency:read
List the portal deal stages: the team default, which funnels override it, each funnel's resolved stages and the system default (Team and above)
list_related_portal_submissions
agency:read
List other submissions from the same email address as a portal submission (up to 20) (Team and above)
list_sub_accounts
agency:read
List the agency's client workspaces (sub-accounts) with their permission level and how many projects each one has (Team and above)
move_portal_submission_stage
agency:write
Move one funnel submission to another stage of its funnel on the portal board and log the change (Team and above)
pause_portal_client
agency:write
Pause a joined portal client: the portal closes immediately and a queued job removes their access until resumed (Team and above)
preview_bundle_deployment
agency:read
Dry run of a rollout to one client; writes nothing (Team and above)
rebind_bundle_deployment
agency:write
Point an open domain or calendar slot of a staged rollout at a destination the agency or client owns (Team and above)
reject_client_deployment
approvals:write
Reject a rollout staged in this client workspace; nothing is published; client admins only
remove_client_report_recipient
agency:write
Remove an outside address from a client report schedule (Team and above)
remove_portal_client
agency:write
Revoke a pending portal invite, or remove a joined client entirely (membership, funnel access, tokens and sessions are removed by a queued j (Team and above)
resend_client_report_confirmation
agency:write
Send the confirmation email to an outside report address again (Team and above)
restore_portal_client
agency:write
Restore an archived portal client as invited; a new invite email is sent and access returns once they accept (Team and above)
resume_portal_client
agency:write
Resume a paused portal client; their access is restored by a queued job (Team and above)
retry_portal_domain
agency:write
Re-queue certificate issuance and the DNS check for the agency portal custom domain (Team and above)
rollback_bundle_deployment
agency:write
Take a rollout back (queued); the previous rollout returns (Team and above)
send_client_report_now
agency:write
Send a client report right now (queued); access is re-checked (Team and above)
set_agency_mode
agency:write
Turn agency mode on or off for the workspace
set_bundle_version_status
agency:write
Move a bundle version through review, draft and publish (Team and above)
set_client_report_schedule_status
agency:write
Pause, resume or revoke a client report schedule (Team and above)
set_portal_domain
agency:write
Set or clear the agency portal custom domain (Team and above)
update_portal_branding
agency:write
Replace the agency portal branding (Team and above)
update_portal_funnel_stages
agency:write
Override the deal stages of one funnel (Team and above)
update_portal_team_stages
agency:write
Replace the team default deal stages used by every funnel without its own override (Team and above)
update_sub_account
agency:write
Rename a client workspace or change its permission level (Team and above)
Developer
Tool
Ability
Description
list_developer_applications
tokens:read
List developer applications with token and SDK key counts
get_developer_application
tokens:read
Read one application: tokens, SDK keys, 30-day usage, recent activity
create_developer_application
tokens:write
Create a developer application
update_developer_application
tokens:write
Update a developer application
delete_developer_application
tokens:write
Delete a developer application
update_token
tokens:write
Replace the abilities of an API token (subset of caller)