Start a ShipMyForm account from an email address, with no browser. A 6-digit code is emailed to the address; verify_account with { email, code } then returns the API key. Works without authentication. Also works for an existing account (the code approves API access).
输入参数agentemail必填presetscopesworkspaceName
verify_account
Verify the account email
Prove the address with the 6-digit code emailed by sign_up. Without a key on the connection, pass the email too: on success this returns the API key (shown once). Turns on email notifications.
输入参数code必填agentemailpresetscopes
resend_verification_code
Resend the verification code
Email a fresh 6-digit verification code to the account's address.
无需输入参数。
The account's email, verification state, plan, limits, usage and dashboard URL.
无需输入参数。
create_api_key
Create an API key
Mint another API key for this workspace (shown once), optionally narrower than this one. A key can never grant scopes it does not itself hold, so this is the safe way to hand a limited key to another agent.
输入参数name必填presetscopes
list_api_keys
List API keys
API keys on this workspace (metadata only).
无需输入参数。
revoke_api_key
Revoke an API key
Revoke a key by id. The key in use on this connection cannot revoke itself.
输入参数keyId必填
start_upgrade
Start a paid plan
Get a hosted checkout URL for the Starter or Business plan. Payment is completed by a person on that page; the plan activates automatically afterwards (check with get_account).
输入参数plan必填period
get_billing_portal
Billing portal link
A self-service billing portal URL: change plan, update the card, cancel.
无需输入参数。
The workspace's forms with their public endpoint URLs.
无需输入参数。
Create a form and get its endpoint plus a paste-ready HTML snippet. Email notifications to the account owner are set up automatically. Works on every plan.
输入参数name必填purposeallowedDomains
A form's full configuration, connectors and hosted-page status.
输入参数formId必填
update_form
Update form settings
Change any subset of a form's settings: name, purpose, allowedDomains, redirectUrl, spamMode, active, storeSubmissions, validation rules, blocklist, autoResponder (Pro).
输入参数nameactiveformId必填purposespamModeblocklistvalidationredirectUrlautoResponderallowedDomainsstoreSubmissions
Delete a form; its endpoint stops accepting submissions.
输入参数formId必填
get_form_snippet
Get form snippet
A copy-paste form snippet for a framework (html, react, vue, or fetch) wired to the form's endpoint.
输入参数formId必填framework
get_submission_stats
Get submission stats
Delivered / spam-held / flagged counts for a form, plus workspace quota usage. Works on every plan.
输入参数formId必填
list_connector_types
List connector types
Every destination submissions can be routed to, with the config fields each needs and which plan it requires.
无需输入参数。
list_connectors
List a form's connectors
Connectors on a form with their status and last error.
输入参数formId必填
add_connector
Add a connector
Route a form's submissions somewhere: email, webhook, Slack, Discord, Airtable, HubSpot, Telegram and more. Get the config fields from list_connector_types. OAuth connectors (Google Sheets, Notion) must be added in the dashboard.
输入参数type必填config必填formId必填
test_connector
Test a connector
Send a test delivery through a connector and report the result.
输入参数connectorId必填
set_connector_active
Enable or disable a connector
输入参数active必填connectorId必填
remove_connector
Remove a connector
输入参数connectorId必填
publish_hosted_page
Publish a hosted form page
Publish a standalone page for the form on shipmyform.com (no website needed) and get its URL plus an embed script. Uses the designed page if one exists, otherwise a default email + message form.
输入参数formId必填
unpublish_hosted_page
Unpublish the hosted page
输入参数formId必填
list_submissions
List submissions
Read submissions across the workspace or for one form, with filters (status, date range, text search, country, attachments, failed deliveries) and paging. Spam is excluded unless status is 'spam'. Requires a paid plan.
输入参数qsortlimitsinceuntilformIdoffsetstatushasFilescountriesdeliveryFailed
get_submission
Get a submission
One submission with spam signals and delivery history.
输入参数submissionId必填
label_submissions
Classify submissions
Mark submissions as spam, ok (not spam) or flagged. spam/ok also teach the classifier, so your judgement improves future filtering. This is how you triage in your own environment: list, decide, label.
输入参数ids必填label必填
delete_submissions
Delete submissions
Permanently delete submissions (and their files).
输入参数ids必填
export_submissions
Export submissions as CSV
All of a form's submissions (up to 2,000) as CSV text, optionally filtered by status.
输入参数formId必填status