Form backend for static sites: create forms, manage submissions, webhooks and exports.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Bearer token from SubmitraX → Settings → API access (format: Bearer <token>)
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Accept a pending workspace invitation using its invitation token, linking it to the authenticated user.
Invitation token from the invite email link
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Accept a pending workspace invitation using its invitation token, linking it to the authenticated user.
| Argument | Type | Description |
|---|---|---|
| token* | string | Invitation token from the invite email link |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"description": "Invitation token from the invite email link"
}
}
}Add a notification webhook URL to a form.
| Argument | Type | Description |
|---|---|---|
| id* | string | Form ID or form key |
| url* | string | Webhook URL (Slack, Discord, or generic HTTP endpoint) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string",
"description": "Form ID or form key"
},
"url": {
"type": "string",
"description": "Webhook URL (Slack, Discord, or generic HTTP endpoint)"
}
}
}Archive several submissions at once.
| Argument | Type | Description |
|---|---|---|
| submissionIds* | array | IDs of the submissions to process |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"submissionIds"
],
"properties": {
"submissionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of the submissions to process"
}
}
}Permanently delete several submissions at once.
| Argument | Type | Description |
|---|---|---|
| submissionIds* | array | IDs of the submissions to process |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"submissionIds"
],
"properties": {
"submissionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of the submissions to process"
}
}
}Delete multiple user accounts at once. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| userIds* | array | IDs of the users to delete |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"userIds"
],
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of the users to delete"
}
}
}Start a Stripe subscription checkout for a plan ('free', 'essentials', 'pro'). Downgrades immediately if planType is 'free'.
| Argument | Type | Description |
|---|---|---|
| planType* | string | Plan to subscribe to |
| billingPeriod | string | Billing period for paid plans |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"planType"
],
"properties": {
"planType": {
"enum": [
"free",
"essentials",
"pro"
],
"type": "string",
"description": "Plan to subscribe to"
},
"billingPeriod": {
"enum": [
"monthly",
"annual"
],
"type": "string",
"description": "Billing period for paid plans"
}
}
}Create a CSV or JSON export of a form's submissions, optionally filtered by date range (YYYY-MM-DD).
| Argument | Type | Description |
|---|---|---|
| formId* | string | Form ID |
| format | string | Export file format |
| end_date | string | Only include submissions up to this date (YYYY-MM-DD) |
| start_date | string | Only include submissions from this date (YYYY-MM-DD) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"formId"
],
"properties": {
"formId": {
"type": "string",
"description": "Form ID"
},
"format": {
"enum": [
"csv",
"json"
],
"type": "string",
"description": "Export file format"
},
"end_date": {
"type": "string",
"description": "Only include submissions up to this date (YYYY-MM-DD)"
},
"start_date": {
"type": "string",
"description": "Only include submissions from this date (YYYY-MM-DD)"
}
}
}Create a new form in a workspace.
| Argument | Type | Description |
|---|---|---|
| name* | string | Name of the form |
| email_to | string | Notification email recipient. Defaults to the authenticated user's email |
| custom_html | string | Custom HTML for the public form page; {{form_url}} is replaced with the submission endpoint |
| workspace_id* | string | ID of the workspace to create the form in |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"workspace_id"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the form"
},
"email_to": {
"type": "string",
"description": "Notification email recipient. Defaults to the authenticated user's email"
},
"custom_html": {
"type": "string",
"description": "Custom HTML for the public form page; {{form_url}} is replaced with the submission endpoint"
},
"workspace_id": {
"type": "string",
"description": "ID of the workspace to create the form in"
}
}
}Create a new template. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| name* | string | Template name |
| slug | string | URL-friendly identifier for the template |
| type* | string | Template type |
| content* | string | Template HTML content |
| is_default | boolean | Whether the template is offered to all users by default |
| description | string | Short description of the template |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"type",
"content"
],
"properties": {
"name": {
"type": "string",
"description": "Template name"
},
"slug": {
"type": "string",
"description": "URL-friendly identifier for the template"
},
"type": {
"enum": [
"form",
"email"
],
"type": "string",
"description": "Template type"
},
"content": {
"type": "string",
"description": "Template HTML content"
},
"is_default": {
"type": "boolean",
"description": "Whether the template is offered to all users by default"
},
"description": {
"type": "string",
"description": "Short description of the template"
}
}
}Create a new workspace owned by the authenticated user.
| Argument | Type | Description |
|---|---|---|
| name* | string | Name of the workspace |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the workspace"
}
}
}Delete every submission belonging to a form.
| Argument | Type | Description |
|---|---|---|
| formId* | string | Form ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"formId"
],
"properties": {
"formId": {
"type": "string",
"description": "Form ID"
}
}
}Delete a form.
| Argument | Type | Description |
|---|---|---|
| id* | string | Form ID or form key |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Form ID or form key"
}
}
}Remove a notification webhook URL from a form.
| Argument | Type | Description |
|---|---|---|
| id* | string | Form ID or form key |
| url* | string | Webhook URL (Slack, Discord, or generic HTTP endpoint) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string",
"description": "Form ID or form key"
},
"url": {
"type": "string",
"description": "Webhook URL (Slack, Discord, or generic HTTP endpoint)"
}
}
}Permanently delete a single submission.
| Argument | Type | Description |
|---|---|---|
| id* | string | Submission ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Submission ID"
}
}
}Delete a template. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| id* | string | Template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Template ID"
}
}
}Delete a single user account. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| id* | string | User ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "User ID"
}
}
}Delete a workspace along with all its forms and submissions. Only the owner may do this.
| Argument | Type | Description |
|---|---|---|
| id* | string | Workspace ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Workspace ID"
}
}
}Download the contents of a previously created export file (CSV or JSON text).
| Argument | Type | Description |
|---|---|---|
| filename* | string | The export filename, as returned by create_export or list_form_exports |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"filename"
],
"properties": {
"filename": {
"type": "string",
"description": "The export filename, as returned by create_export or list_form_exports"
}
}
}Proxy a request to the configured n8n AI generation webhook (e.g. for AI-assisted form/HTML generation). Requires the server to have AI generation configured.
| Argument | Type | Description |
|---|---|---|
| payload* | object | Arbitrary JSON payload forwarded to the AI generation webhook |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"payload"
],
"properties": {
"payload": {
"type": "object",
"description": "Arbitrary JSON payload forwarded to the AI generation webhook",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
}Generate (or reset) a long-lived API token (sk_...) scoped to a single workspace, for use with public API integrations.
| Argument | Type | Description |
|---|---|---|
| id* | string | Workspace ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Workspace ID"
}
}
}Check whether an auth token is currently configured for this session.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Get the profile of the currently authenticated user.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Get a single form by id or form key.
| Argument | Type | Description |
|---|---|---|
| id* | string | Form ID or form key |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Form ID or form key"
}
}
}Fetch the rendered public HTML (custom or default template) for a form by its form key. No authentication required.
| Argument | Type | Description |
|---|---|---|
| formKey* | string | Public form key, as used in the /f/:formKey URL |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"formKey"
],
"properties": {
"formKey": {
"type": "string",
"description": "Public form key, as used in the /f/:formKey URL"
}
}
}Get a single workspace's details and settings.
| Argument | Type | Description |
|---|---|---|
| id* | string | Workspace ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Workspace ID"
}
}
}Check whether the SubmitraX API is reachable and running.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Invite a new member to a workspace by email. Requires admin access to the workspace.
| Argument | Type | Description |
|---|---|---|
| yourName* | string | Name of the inviter, shown in the invitation email |
| theirName* | string | Name of the person being invited |
| theirEmail* | string | Email address to send the invitation to |
| workspaceId* | string | Workspace ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"workspaceId",
"theirName",
"theirEmail",
"yourName"
],
"properties": {
"yourName": {
"type": "string",
"description": "Name of the inviter, shown in the invitation email"
},
"theirName": {
"type": "string",
"description": "Name of the person being invited"
},
"theirEmail": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Email address to send the invitation to"
},
"workspaceId": {
"type": "string",
"description": "Workspace ID"
}
}
}Paginated list of all users with plan stats. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| page | number | Page number, starting at 1 |
| limit | number | Number of users per page |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "number",
"description": "Page number, starting at 1"
},
"limit": {
"type": "number",
"description": "Number of users per page"
}
}
}Paginated list of every template. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| page | number | Page number, starting at 1 |
| type | string | Only return templates of this type |
| limit | number | Number of templates per page |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "number",
"description": "Page number, starting at 1"
},
"type": {
"enum": [
"form",
"email"
],
"type": "string",
"description": "Only return templates of this type"
},
"limit": {
"type": "number",
"description": "Number of templates per page"
}
}
}List the export files previously created for a form.
| Argument | Type | Description |
|---|---|---|
| formId* | string | Form ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"formId"
],
"properties": {
"formId": {
"type": "string",
"description": "Form ID"
}
}
}List all submissions for a specific form.
| Argument | Type | Description |
|---|---|---|
| formId* | string | Form ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"formId"
],
"properties": {
"formId": {
"type": "string",
"description": "Form ID"
}
}
}List the notification webhook URLs (Slack, Discord, generic) configured on a form.
| Argument | Type | Description |
|---|---|---|
| id* | string | Form ID or form key |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Form ID or form key"
}
}
}List forms across the user's workspaces, or within one workspace if workspace_id is given.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Only include this workspace |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Only include this workspace"
}
}
}List submissions across the user's workspaces, or within one workspace if workspace_id is given.
| Argument | Type | Description |
|---|---|---|
| workspace_id | string | Only include this workspace |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"workspace_id": {
"type": "string",
"description": "Only include this workspace"
}
}
}List default templates available to all users, optionally filtered by type ('form' or 'email').
| Argument | Type | Description |
|---|---|---|
| type | string | Only return templates of this type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"type": {
"enum": [
"form",
"email"
],
"type": "string",
"description": "Only return templates of this type"
}
}
}List members and pending invitations of a workspace, including its owner.
| Argument | Type | Description |
|---|---|---|
| workspaceId* | string | Workspace ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"workspaceId"
],
"properties": {
"workspaceId": {
"type": "string",
"description": "Workspace ID"
}
}
}List workspaces owned by or shared with the authenticated user.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Log in with email and password. Stores the returned token for subsequent authenticated tool calls.
| Argument | Type | Description |
|---|---|---|
| email* | string | Account email address |
| password* | string | Account password |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email",
"password"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Account email address"
},
"password": {
"type": "string",
"description": "Account password"
}
}
}Log in or register using a Google Sign-In ID token credential. Stores the returned token for subsequent authenticated tool calls.
| Argument | Type | Description |
|---|---|---|
| credential* | string | Google ID token credential |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"credential"
],
"properties": {
"credential": {
"type": "string",
"description": "Google ID token credential"
}
}
}Mark a submission as read so it no longer shows as new.
| Argument | Type | Description |
|---|---|---|
| id* | string | Submission ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Submission ID"
}
}
}Redeem a voucher code to add submission quota to a workspace's owner.
| Argument | Type | Description |
|---|---|---|
| id* | string | Workspace ID |
| code* | string | Voucher code to redeem |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"code"
],
"properties": {
"id": {
"type": "string",
"description": "Workspace ID"
},
"code": {
"type": "string",
"description": "Voucher code to redeem"
}
}
}Register a new SubmitraX user account. Stores the returned token for subsequent authenticated tool calls.
| Argument | Type | Description |
|---|---|---|
| name | string | Display name of the user |
| email* | string | Email address for the new account |
| password* | string | Password for the new account |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email",
"password"
],
"properties": {
"name": {
"type": "string",
"description": "Display name of the user"
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Email address for the new account"
},
"password": {
"type": "string",
"description": "Password for the new account"
}
}
}Remove a member (or cancel a pending invitation) from a workspace. Requires admin access to the workspace.
| Argument | Type | Description |
|---|---|---|
| memberId* | string | Member ID, as returned by list_workspace_members |
| workspaceId* | string | Workspace ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"workspaceId",
"memberId"
],
"properties": {
"memberId": {
"type": "string",
"description": "Member ID, as returned by list_workspace_members"
},
"workspaceId": {
"type": "string",
"description": "Workspace ID"
}
}
}Resend the email notification for a submission.
| Argument | Type | Description |
|---|---|---|
| id* | string | Submission ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Submission ID"
}
}
}Set the bearer token (JWT from login/register, or a workspace API token starting with sk_) used to authenticate subsequent tool calls.
| Argument | Type | Description |
|---|---|---|
| token* | string | JWT or workspace API token (sk_...) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"description": "JWT or workspace API token (sk_...)"
}
}
}Trigger a demo submission email for marketing/demo purposes. No authentication required, rate-limited.
| Argument | Type | Description |
|---|---|---|
| data | object | Example form field values to include in the demo email |
| email* | string | Email address that receives the demo notification |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email"
],
"properties": {
"data": {
"type": "object",
"description": "Example form field values to include in the demo email",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Email address that receives the demo notification"
}
}
}Submit data to a public form endpoint, as an end user would. No authentication required.
| Argument | Type | Description |
|---|---|---|
| data* | object | Form field values, e.g. { "name": "Jane", "email": "[email protected]" } |
| formKey* | string | Public form key, as used in the /f/:formKey URL |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"formKey",
"data"
],
"properties": {
"data": {
"type": "object",
"description": "Form field values, e.g. { \"name\": \"Jane\", \"email\": \"[email protected]\" }",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"formKey": {
"type": "string",
"description": "Public form key, as used in the /f/:formKey URL"
}
}
}Flip a submission's archived state.
| Argument | Type | Description |
|---|---|---|
| id* | string | Submission ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Submission ID"
}
}
}Flip a submission's spam state.
| Argument | Type | Description |
|---|---|---|
| id* | string | Submission ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Submission ID"
}
}
}Update a form's settings (name, notification email, Slack webhook, redirect URL, custom HTML, active state, or arbitrary settings).
| Argument | Type | Description |
|---|---|---|
| id* | string | Form ID or form key |
| name | string | New name of the form |
| email_to | string | Notification email recipient |
| settings | object | Additional form settings to merge |
| is_active | boolean | Whether the form accepts submissions |
| custom_html | string | Custom HTML for the public form page; {{form_url}} is replaced with the submission endpoint |
| redirect_url | string | URL to redirect submitters to after a successful submission |
| slack_webhook | string | Slack incoming webhook URL for submission notifications |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Form ID or form key"
},
"name": {
"type": "string",
"description": "New name of the form"
},
"email_to": {
"type": "string",
"description": "Notification email recipient"
},
"settings": {
"type": "object",
"description": "Additional form settings to merge",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"is_active": {
"type": "boolean",
"description": "Whether the form accepts submissions"
},
"custom_html": {
"type": "string",
"description": "Custom HTML for the public form page; {{form_url}} is replaced with the submission endpoint"
},
"redirect_url": {
"type": "string",
"description": "URL to redirect submitters to after a successful submission"
},
"slack_webhook": {
"type": "string",
"description": "Slack incoming webhook URL for submission notifications"
}
}
}Change a workspace member's role. Requires admin access to the workspace.
| Argument | Type | Description |
|---|---|---|
| role* | string | New role, e.g. 'admin' or 'member' |
| memberId* | string | Member ID, as returned by list_workspace_members |
| workspaceId* | string | Workspace ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"workspaceId",
"memberId",
"role"
],
"properties": {
"role": {
"type": "string",
"description": "New role, e.g. 'admin' or 'member'"
},
"memberId": {
"type": "string",
"description": "Member ID, as returned by list_workspace_members"
},
"workspaceId": {
"type": "string",
"description": "Workspace ID"
}
}
}Update a template. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| id* | string | Template ID |
| name | string | Template name |
| slug | string | URL-friendly identifier for the template |
| type | string | Template type |
| content | string | Template HTML content |
| is_default | boolean | Whether the template is offered to all users by default |
| description | string | Short description of the template |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Template ID"
},
"name": {
"type": "string",
"description": "Template name"
},
"slug": {
"type": "string",
"description": "URL-friendly identifier for the template"
},
"type": {
"enum": [
"form",
"email"
],
"type": "string",
"description": "Template type"
},
"content": {
"type": "string",
"description": "Template HTML content"
},
"is_default": {
"type": "boolean",
"description": "Whether the template is offered to all users by default"
},
"description": {
"type": "string",
"description": "Short description of the template"
}
}
}Set a user's plan ('free' or 'pro') and its associated quota. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| id* | string | User ID |
| plan* | string | Plan to assign |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"plan"
],
"properties": {
"id": {
"type": "string",
"description": "User ID"
},
"plan": {
"enum": [
"free",
"pro"
],
"type": "string",
"description": "Plan to assign"
}
}
}Set a user's submission quota directly. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| id* | string | User ID |
| submission_quota* | number | New submission quota |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"submission_quota"
],
"properties": {
"id": {
"type": "string",
"description": "User ID"
},
"submission_quota": {
"type": "number",
"description": "New submission quota"
}
}
}Grant or revoke super-admin status for a user. Requires super-admin.
| Argument | Type | Description |
|---|---|---|
| id* | string | User ID |
| is_super_admin* | boolean | true to grant super-admin, false to revoke |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"is_super_admin"
],
"properties": {
"id": {
"type": "string",
"description": "User ID"
},
"is_super_admin": {
"type": "boolean",
"description": "true to grant super-admin, false to revoke"
}
}
}Rename a workspace or change its settings.
| Argument | Type | Description |
|---|---|---|
| id* | string | Workspace ID |
| name | string | New workspace name |
| settings | object | Workspace settings to merge |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Workspace ID"
},
"name": {
"type": "string",
"description": "New workspace name"
},
"settings": {
"type": "object",
"description": "Workspace settings to merge",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
}Change the authenticated user's plan (defaults to 'pro' if not specified).
| Argument | Type | Description |
|---|---|---|
| plan | string | Plan to switch to, e.g. 'pro' (default) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"plan": {
"type": "string",
"description": "Plan to switch to, e.g. 'pro' (default)"
}
}
}