/forms/{formId}/submitactions

Create a new submit action that defines what happens after a form is submitted

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Unique identifier of the form to add the submit action to

Body Params

Request payload for creating a new submit action on a form

string | null

Display name for the submit action

string
enum

Type of action to perform after form submission: 'default' for standard processing, 'message' to display custom content, or 'redirect' to navigate to a URL

Allowed:
string | null

HTML content to display to users (required when type is 'message')

uri | null

Target URL to redirect users to (required when type is 'redirect')

boolean | null
Defaults to false

Whether to append form submission data as query parameters to the redirect URL

logic

Conditional logic rules that determine when this submit action should be executed based on form field values

Responses

400

Invalid request data or validation failed

403

Access denied - insufficient permissions

404

Form not found

500

Internal server error during submit action creation

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json