Create a form action

post

https://api.salesautopilot.com/v2/form/{formId}/actions

Create an action that fires when a subscriber submits the specified form.

No letter_trigger is required for form actions — the trigger is always the form submission itself.

source_list_id (optional request body) — source list override:

Omit or pass 0 (default): the source list is automatically the form's parent list.
Pass a specific list ID: that list is always used as the source.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

formId

integer

required

ID of the form

Body Params

action_type

string

enum

required

Type of action to perform

Allowed:

name

string

required

Descriptive name of the action

source_list_id

integer

Source list override. Optional.

0 or omitted (default): source list is automatically the form's parent list.
Specific ID: that list is always used as the source.

target_list_id

integer

Target list — the contact is subscribed to / unsubscribed from / updated in / deleted from this list.
Required for subscribe, unsubscribe, update, delete. Not required for external.

fields

array of objects

Field-value pairs to update. Required when action_type is update.

fields

external_url

string

Webhook URL to call. Required when action_type is external.

external_method

string

enum

Defaults to json

Data format for the external call.

Allowed:

external_username

string

HTTP Basic auth username for the external call.

external_password

string

HTTP Basic auth password for the external call.

notify_on_action

boolean

Send a notification email when this action fires.

source_segments

array of integers

Source list segment IDs to filter by (form actions only). Only contacts in (or not in) these segments trigger the action. Omit to disable filtering.

source_segments

source_segment_conn_type

string

enum

Defaults to or

Logical connector between source segments.

Allowed:

source_segment_negated_ids

array of integers

Subset of source_segments IDs to negate — contacts in these segments are excluded instead of included.

source_segment_negated_ids

target_segments

array of integers

Target list segment IDs to filter by. Only contacts in (or not in) these segments are affected. Omit to disable filtering.

target_segments

target_segment_conn_type

string

enum

Defaults to or

Logical connector between target segments.

Allowed:

target_segment_negated_ids

array of integers

Subset of target_segments IDs to negate — contacts in these segments are excluded instead of included.

target_segment_negated_ids

Responses

200Action created successfully

400Validation error

401Authentication required or invalid token

404Form not found

429Rate limit exceeded

500Internal server error