The field of the criterion to filter the mailing list by (e.g., 'Email', 'Name', custom field names).
valuestring
Required
A search term to filter the specified field by.
formatstring
Response format. Use 'json' (recommended and default) or 'xml'. Note: XML responses require additional parsing.
date_tostring
Provides an additional filter option to be combined with date-based fields. Format: ISO 8601 date string.
comparerstring
An operator that defines the way to compare a criterion field with its value (e.g., 'Is', 'IsNot', 'Contains', 'NotContains', 'StartsWith', 'EndsWith').
date_fromstring
Provides an additional filter option to be combined with date-based fields. Format: ISO 8601 date string.
segment_idstring
Required
The ID of the segment containing the criterion to update.
criteria_idinteger
Required
The ID of the criterion to update.
mailing_list_idstring
Required
The ID of the mailing list the specified segment belongs to.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not