Update an action

Partially update an existing action (letter or form). All request body fields are optional — only the fields you supply are changed. Fields omitted from the request retain their current values.

source_list_id — optional source list change:

  • Pass 0 to revert to automatic (letter: source = the send's target list; form: source = the form's parent list).
  • Pass a specific list ID to fix the source list.
  • Omit entirely to keep the current source list setting unchanged.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the action

Body Params

All fields are optional — only supplied fields are updated. Works for both letter actions and form actions.

string
enum
Allowed:
string
string
enum

Letter trigger (applicable to letter actions only).

Allowed:
integer

Source list change. Optional.

  • 0: revert to automatic — for letter actions: source = the send's target list; for form actions: source = the form's parent list.
  • Specific ID: fix the source list to this value.
  • Omit: keep the current source list setting unchanged.
integer

New target list — the contact will be subscribed to / unsubscribed from / updated in / deleted from this list.

link_urls
array of strings
fields
array of objects
fields
string
string
enum
Allowed:
string
string
boolean
source_segments
array of integers

New source segment IDs (form actions only). Update semantics:

  • Omit: keep existing segments unchanged.
  • [] (empty array): clear all segments (disable filtering).
  • Non-empty array: replace existing segments.
source_segments
string
enum

Logical connector between source segments — form actions only (omit to keep existing).

Allowed:
source_segment_negated_ids
array of integers

Subset of source_segments to negate. Must be a subset of the source_segments provided.

source_segment_negated_ids
target_segments
array of integers

New target segment IDs. Update semantics:

  • Omit: keep existing segments unchanged.
  • [] (empty array): clear all segments (disable filtering).
  • Non-empty array: replace existing segments.
target_segments
string
enum

Logical connector between target segments (omit to keep existing).

Allowed:
target_segment_negated_ids
array of integers

Subset of target_segments to negate. Must be a subset of the target_segments provided.

target_segment_negated_ids
Responses

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