> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GetResponse

> Manage GetResponse email marketing, contacts, campaigns, automation, ecommerce, and account resources.

![GetResponse logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/getresponse.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=9e8ff3e09978270e0223f90eaed7bc1d)

* **Category:** marketing automation
* **Auth:** API\_KEY, OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 213
* **Triggers:** 0
* **Slug:** `GETRESPONSE`
* **Version:** 20261101\_00

## Tools

> [accordion] Cancel A/B test
>
> **Slug:** `GETRESPONSE_CANCEL_AB_TEST`
>
> Schedule cancellation of an A/B test.
>
> #### Input Parameters
>
> **ab\_test\_id** `string` *required*
>
> A/B test ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel sending the newsletter
>
> **Slug:** `GETRESPONSE_CANCEL_NEWSLETTER_SEND`
>
> Cancel newsletter sending and turn the newsletter into a draft.
>
> #### Input Parameters
>
> **newsletter\_id** `string` *required*
>
> Newsletter ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create address
>
> **Slug:** `GETRESPONSE_CREATE_ADDRESS`
>
> Create an address in the connected GetResponse account.
>
> #### Input Parameters
>
> **zip** `string`
>
> ZIP or postal code.
>
> **city** `string`
>
> City.
>
> **name** `string` *required*
>
> Address label.
>
> **phone** `string`
>
> Phone number.
>
> **company** `string`
>
> Company name.
>
> **address1** `string`
>
> First street-address line.
>
> **address2** `string`
>
> Second street-address line.
>
> **province** `string`
>
> Province or state name.
>
> **last\_name** `string`
>
> Recipient last name.
>
> **first\_name** `string`
>
> Recipient first name.
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-3 country code.
>
> **province\_code** `string`
>
> Province or state code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create and send newsletter
>
> **Slug:** `GETRESPONSE_CREATE_AND_SEND_NEWSLETTER`
>
> Create a newsletter and immediately queue delivery, or schedule it when send\_settings.sendOn is supplied. GetResponse limits this endpoint to 256 calls per day.
>
> #### Input Parameters
>
> **name** `string`
>
> Newsletter name.
>
> **flags** `array`
>
> Message tracking flags.
>
> **content** `object` *required*
>
> Newsletter message content.
>
> **subject** `string` *required*
>
> Message subject.
>
> **campaign** `object` *required*
>
> Campaign assigned to the newsletter.
>
> **reply\_to** `object`
>
> Reply-to email address.
>
> **from\_field** `object` *required*
>
> From email address.
>
> **attachments** `array`
>
> Base64 attachments; combined size must not exceed 400 KB.
>
> **track\_opens** `string ("true" | "false")`
>
> Whether opens are tracked; defaults to true upstream.
>
> **send\_settings** `object` *required*
>
> Recipient and delivery settings required by GetResponse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create autoresponder
>
> **Slug:** `GETRESPONSE_CREATE_AUTORESPONDER`
>
> Create an autoresponder with configured trigger and delivery timing. When enabled, it can automatically deliver its message when those conditions are met.
>
> #### Input Parameters
>
> **name** `string`
>
> Autoresponder name.
>
> **flags** `array`
>
> Message tracking flags.
>
> **status** `string ("enabled" | "disabled")` *required*
>
> Autoresponder status.
>
> **content** `object` *required*
>
> Message content.
>
> **subject** `string` *required*
>
> Autoresponder message subject.
>
> **reply\_to** `object`
>
> Reply-to address.
>
> **from\_field** `object`
>
> Sender address.
>
> **campaign\_id** `string`
>
> Campaign ID; omitted uses the default campaign.
>
> **track\_opens** `string ("true" | "false")`
>
> Whether to track message opens.
>
> **send\_settings** `object` *required*
>
> Delivery settings.
>
> **trigger\_settings** `object` *required*
>
> Autoresponder trigger conditions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create campaign
>
> **Slug:** `GETRESPONSE_CREATE_CAMPAIGN`
>
> Create a campaign (contact list); configured double opt-in can automatically send confirmation emails, and subscription notifications can alert configured recipients.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique campaign (contact list) name.
>
> **postal** `object`
>
> Postal-address settings.
>
> **profile** `object`
>
> Public campaign profile settings.
>
> **is\_default** `string ("true" | "false")`
>
> Whether this should be the default campaign.
>
> **optin\_types** `object`
>
> Opt-in settings by subscription source.
>
> **confirmation** `object`
>
> Subscription confirmation settings.
>
> **language\_code** `string`
>
> ISO 639-1 campaign language code, also accepting zt, fs, and md.
>
> **subscription\_notifications** `object`
>
> Subscription notification settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create cart
>
> **Slug:** `GETRESPONSE_CREATE_CART`
>
> Create a cart with its selected product variants.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **cart\_url** `string`
>
> External cart URL.
>
> **currency** `string` *required*
>
> ISO 4217 currency code.
>
> **contact\_id** `string` *required*
>
> Contact ID that owns the cart.
>
> **external\_id** `string`
>
> External cart ID.
>
> **total\_price** `number` *required*
>
> Total cart price excluding tax.
>
> **total\_tax\_price** `number`
>
> Total cart price including tax.
>
> **selected\_variants** `array` *required*
>
> Variants selected in the cart.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create category
>
> **Slug:** `GETRESPONSE_CREATE_CATEGORY`
>
> Create a shop category; setting is\_default makes it the shop's default category and changes the previous default.
>
> #### Input Parameters
>
> **url** `string`
>
> External URL for the category.
>
> **name** `string` *required*
>
> The category name.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **parent\_id** `string`
>
> The parent category ID.
>
> **is\_default** `boolean`
>
> Whether this is the default category.
>
> **external\_id** `string`
>
> Category ID assigned by another system.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a new contact
>
> **Slug:** `GETRESPONSE_CREATE_CONTACT`
>
> Submit a contact for asynchronous creation in a campaign. GetResponse returns no contact ID; use LIST\_CONTACTS with the email filter to find the contact after processing.
>
> #### Input Parameters
>
> **name** `string`
>
> Contact name.
>
> **tags** `array`
>
> Tags to assign to the contact.
>
> **email** `string` *required*
>
> Contact email address.
>
> **scoring** `number`
>
> Contact score; null removes the score.
>
> **campaign** `object` *required*
>
> Campaign in which to create the contact.
>
> **ip\_address** `string`
>
> Contact IPv4 or IPv6 address.
>
> **day\_of\_cycle** `string`
>
> Autoresponder cycle day; null means not in the cycle.
>
> **custom\_field\_values** `array`
>
> Custom field values to assign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create multiple contacts at once
>
> **Slug:** `GETRESPONSE_CREATE_CONTACTS_BATCH`
>
> Submit multiple contacts for asynchronous creation in one campaign. GetResponse returns no contact IDs; use LIST\_CONTACTS after processing to find accepted contacts.
>
> #### Input Parameters
>
> **contacts** `array` *required*
>
> Contacts to create (1-1000 contacts per batch).
>
> **campaign\_id** `string` *required*
>
> Destination campaign ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a custom event
>
> **Slug:** `GETRESPONSE_CREATE_CUSTOM_EVENT`
>
> Create a custom event definition with typed attributes.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique custom event name.
>
> **attributes** `array` *required*
>
> Attributes defined for the custom event.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a custom field
>
> **Slug:** `GETRESPONSE_CREATE_CUSTOM_FIELD`
>
> Create a custom field definition.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique lowercase custom field name using only letters, digits, and underscores.
>
> **type** `string ("string" | "number" | "date" | "datetime" | "country" | "currency" | "phone" | "gender" | "ip" | "url")` *required*
>
> The data type accepted by the custom field.
>
> **format** `string ("text" | "textarea" | "radio" | "checkbox" | "single_select" | "multi_select")` *required*
>
> The input format used by the custom field.
>
> **hidden** `string ("true" | "false")` *required*
>
> Whether the custom field is visible to contacts, as a provider string boolean.
>
> **values** `array` *required*
>
> Default choices; radio and select formats require at least two values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create the custom report
>
> **Slug:** `GETRESPONSE_CREATE_CUSTOM_REPORT`
>
> Schedule a one-time custom report. Requires a paid custom-reports entitlement, and available report types depend on the pricing plan.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Custom report name.
>
> **type** `string ("subscription_rejections" | "message_stats" | "unsubscribe_contacts_lists_report" | "standard_subscriber_activity_report" | "bounces" | "account_summary_report" | "user_activity" | "list_summary_report" | "isp_message_stats_report" | "webinar_participants_report" | "import_error_report" | "message_clicks_report" | "unconfirmed_contacts_stats_report" | "transactional_email_bounce_report" | "message_activity_report")` *required*
>
> Custom report type; availability varies by pricing plan.
>
> **filters** `object`
>
> Required message activity filters; valid only for message\_activity\_report.
>
> **scheduling** `object` *required*
>
> One-time reporting period.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a file
>
> **Slug:** `GETRESPONSE_CREATE_FILE`
>
> Create a File Library file from base64-encoded content.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> File name.
>
> **folder** `string` *required*
>
> Folder in which to store the file, or null for the root-folder mode.
>
> **content** `string` *required*
>
> Base64-encoded file bytes, without a data URL prefix.
>
> **extension** `string` *required*
>
> File extension without a leading dot.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a folder
>
> **Slug:** `GETRESPONSE_CREATE_FOLDER`
>
> Create a File Library folder.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Folder name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create 'From' address
>
> **Slug:** `GETRESPONSE_CREATE_FROM_ADDRESS`
>
> Create a GetResponse sender name and email address.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name associated with the sender email address.
>
> **email** `string` *required*
>
> Email address to use as a sender.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a contact import
>
> **Slug:** `GETRESPONSE_CREATE_IMPORT`
>
> Start an asynchronous contact import into a campaign.
>
> #### Input Parameters
>
> **contacts** `array` *required*
>
> Contact rows whose values correspond positionally to field\_mapping.
>
> **campaign\_id** `string` *required*
>
> ID of the destination campaign (contact list).
>
> **field\_mapping** `array` *required*
>
> Column mapping for each contact row. Include email and custom field names in row order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create meta field
>
> **Slug:** `GETRESPONSE_CREATE_META_FIELD`
>
> Create a meta field in a shop.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The meta field name.
>
> **value** `string` *required*
>
> The meta field value.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **value\_type** `string ("string" | "integer")` *required*
>
> The meta field value type.
>
> **description** `string`
>
> The meta field description.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create newsletter draft
>
> **Slug:** `GETRESPONSE_CREATE_NEWSLETTER_DRAFT`
>
> Create a newsletter draft without sending or scheduling delivery. GetResponse requires send\_settings but stores the message as a draft.
>
> #### Input Parameters
>
> **name** `string`
>
> Newsletter name.
>
> **flags** `array`
>
> Message tracking flags.
>
> **content** `object` *required*
>
> Newsletter message content.
>
> **subject** `string` *required*
>
> Message subject.
>
> **campaign** `object` *required*
>
> Campaign assigned to the newsletter.
>
> **reply\_to** `object`
>
> Reply-to email address.
>
> **from\_field** `object` *required*
>
> From email address.
>
> **attachments** `array`
>
> Base64 attachments; combined size must not exceed 400 KB.
>
> **track\_opens** `string ("true" | "false")`
>
> Whether opens are tracked; defaults to true upstream.
>
> **send\_settings** `object` *required*
>
> Recipient and delivery settings required by GetResponse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create order
>
> **Slug:** `GETRESPONSE_CREATE_ORDER`
>
> Create an ecommerce order and trigger matching Make a purchase workflows unless additional\_flags is skipAutomation.
>
> #### Input Parameters
>
> **status** `string`
>
> Order status.
>
> **cart\_id** `string`
>
> Associated cart ID.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **currency** `string` *required*
>
> ISO 4217 order currency code.
>
> **order\_url** `string`
>
> External URL for the order.
>
> **contact\_id** `string` *required*
>
> ID of the contact placing the order.
>
> **description** `string`
>
> Order description.
>
> **external\_id** `string`
>
> Order ID assigned by another system.
>
> **meta\_fields** `array`
>
> Order metadata fields.
>
> **total\_price** `number` *required*
>
> Total order price.
>
> **processed\_at** `string`
>
> Exact ISO 8601 time the order was made.
>
> **billing\_status** `string`
>
> Order billing status.
>
> **shipping\_price** `number`
>
> Shipping price.
>
> **billing\_address** `object`
>
> Complete billing address.
>
> **total\_price\_tax** `number`
>
> Total order tax.
>
> **additional\_flags** `string`
>
> Use `skipAutomation` to avoid triggering Make a purchase workflows.
>
> **shipping\_address** `object`
>
> Complete shipping address.
>
> **selected\_variants** `array` *required*
>
> Selected product variants in the order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a predefined field
>
> **Slug:** `GETRESPONSE_CREATE_PREDEFINED_FIELD`
>
> Create a campaign-specific predefined field in GetResponse.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Predefined field name containing letters, numbers, and underscores.
>
> **value** `string` *required*
>
> Value substituted for the predefined field.
>
> **campaign** `object` *required*
>
> Campaign associated with the predefined field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create product
>
> **Slug:** `GETRESPONSE_CREATE_PRODUCT`
>
> Create a product and its nested ecommerce data in a shop.
>
> #### Input Parameters
>
> **url** `string`
>
> External product URL.
>
> **name** `string` *required*
>
> Product name.
>
> **type** `string`
>
> Product type.
>
> **vendor** `string`
>
> Product vendor.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **variants** `array` *required*
>
> Product variants.
>
> **categories** `array`
>
> Product categories.
>
> **external\_id** `string`
>
> External product ID.
>
> **meta\_fields** `array`
>
> Product meta fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create product variant
>
> **Slug:** `GETRESPONSE_CREATE_PRODUCT_VARIANT`
>
> Create a product variant with images, meta fields, and taxes.
>
> #### Input Parameters
>
> **sku** `string` *required*
>
> Unique stock-keeping unit.
>
> **url** `string`
>
> External variant URL.
>
> **name** `string` *required*
>
> Variant name.
>
> **price** `number` *required*
>
> Price excluding tax.
>
> **taxes** `array`
>
> Variant taxes.
>
> **images** `array`
>
> Variant images.
>
> **barcode** `string`
>
> Variant barcode.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **position** `integer`
>
> Variant position.
>
> **quantity** `integer`
>
> Available quantity.
>
> **price\_tax** `number` *required*
>
> Price including tax.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> **description** `string`
>
> Variant description.
>
> **external\_id** `string`
>
> External variant ID.
>
> **meta\_fields** `array`
>
> Variant meta fields.
>
> **previous\_price** `number`
>
> Previous price excluding tax.
>
> **previous\_price\_tax** `number`
>
> Previous price including tax.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create RSS newsletter
>
> **Slug:** `GETRESPONSE_CREATE_RSS_NEWSLETTER`
>
> Create and configure an RSS-to-email newsletter, which can deliver new feed content when enabled. Requires the RSS email-marketing entitlement.
>
> #### Input Parameters
>
> **name** `string`
>
> Internal newsletter name.
>
> **flags** `array`
>
> Message tracking flags.
>
> **editor** `string ("custom" | "text" | "getresponse" | "legacy" | "html2")`
>
> Editor used to create the message.
>
> **status** `string ("enabled" | "disabled")` *required*
>
> RSS newsletter status.
>
> **content** `object` *required*
>
> Message content.
>
> **subject** `string` *required*
>
> RSS message subject.
>
> **reply\_to** `object`
>
> Reply-to address.
>
> **from\_field** `object` *required*
>
> Sender address.
>
> **rss\_feed\_url** `string` *required*
>
> RSS feed URL.
>
> **send\_settings** `object` *required*
>
> Delivery and audience settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create search contacts
>
> **Slug:** `GETRESPONSE_CREATE_SAVED_CONTACT_SEARCH`
>
> Create a saved contact search from condition sections.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique saved-search name.
>
> **section** `array` *required*
>
> Search sections to save.
>
> **subscribers\_type** `array`
>
> Subscription statuses included in the search.
>
> **section\_logic\_operator** `string ("or" | "and")` *required*
>
> Match any or all search sections.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create shop
>
> **Slug:** `GETRESPONSE_CREATE_SHOP`
>
> Create an ecommerce shop.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The shop name.
>
> **locale** `string` *required*
>
> ISO 639-1 language locale.
>
> **currency** `string` *required*
>
> ISO 4217 currency code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a subject A/B test
>
> **Slug:** `GETRESPONSE_CREATE_SUBJECT_AB_TEST`
>
> Create a subject-line A/B test with two to five variants and start or schedule delivery to its selected recipients.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> A/B test name.
>
> **flags** `array`
>
> Tracking options enabled for the test.
>
> **content** `object` *required*
>
> Message content shared by the variants.
>
> **campaign** `object` *required*
>
> Campaign assigned to the A/B test.
>
> **reply\_to** `object`
>
> Reply-to address.
>
> **variants** `array` *required*
>
> Two to five subject variants, each no longer than 150 characters.
>
> **from\_field** `object` *required*
>
> From address used by the variants.
>
> **send\_settings** `object` *required*
>
> Recipient selection settings.
>
> **delivery\_settings** `object` *required*
>
> A/B test delivery settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a suppression list
>
> **Slug:** `GETRESPONSE_CREATE_SUPPRESSION`
>
> Create a new suppression list.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The suppression list name.
>
> **masks** `array`
>
> Masks to add to the suppression list, such as email addresses or domains.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add a new tag
>
> **Slug:** `GETRESPONSE_CREATE_TAG`
>
> Add a new tag.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Tag name containing only letters, digits, and underscores.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create tax
>
> **Slug:** `GETRESPONSE_CREATE_TAX`
>
> Create a tax for a shop.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The tax name.
>
> **rate** `number` *required*
>
> The tax rate.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create transactional email template
>
> **Slug:** `GETRESPONSE_CREATE_TRANSACTIONAL_EMAIL_TEMPLATE`
>
> Create a reusable transactional email template.
>
> #### Input Parameters
>
> **content** `object`
>
> Optional plain-text and/or HTML template content.
>
> **subject** `string` *required*
>
> Template subject.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete A/B test
>
> **Slug:** `GETRESPONSE_DELETE_AB_TEST`
>
> Delete an A/B test.
>
> #### Input Parameters
>
> **ab\_test\_id** `string` *required*
>
> A/B test ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete address
>
> **Slug:** `GETRESPONSE_DELETE_ADDRESS`
>
> Delete an existing GetResponse account address.
>
> #### Input Parameters
>
> **address\_id** `string` *required*
>
> The address ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete autoresponder
>
> **Slug:** `GETRESPONSE_DELETE_AUTORESPONDER`
>
> Permanently delete an autoresponder.
>
> #### Input Parameters
>
> **autoresponder\_id** `string` *required*
>
> Autoresponder ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete cart
>
> **Slug:** `GETRESPONSE_DELETE_CART`
>
> Delete a cart from a shop.
>
> #### Input Parameters
>
> **cart\_id** `string` *required*
>
> Cart ID.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete category
>
> **Slug:** `GETRESPONSE_DELETE_CATEGORY`
>
> Delete a category from a shop.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **category\_id** `string` *required*
>
> The category ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete a contact by contact ID
>
> **Slug:** `GETRESPONSE_DELETE_CONTACT`
>
> Permanently remove a contact; when message\_id is supplied, record the removal as an unsubscribe from that message, optionally with the source IP address.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Unique contact ID.
>
> **ip\_address** `string`
>
> IPv4 address from which the contact unsubscribed; use with message\_id.
>
> **message\_id** `string`
>
> Message ID used to simulate an unsubscribe from that message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete a custom event
>
> **Slug:** `GETRESPONSE_DELETE_CUSTOM_EVENT`
>
> Delete a custom event definition by ID.
>
> #### Input Parameters
>
> **custom\_event\_id** `string` *required*
>
> Custom event ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete a custom field
>
> **Slug:** `GETRESPONSE_DELETE_CUSTOM_FIELD`
>
> Delete a custom field definition by ID.
>
> #### Input Parameters
>
> **custom\_field\_id** `string` *required*
>
> The custom field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete file by file ID
>
> **Slug:** `GETRESPONSE_DELETE_FILE`
>
> Permanently delete a File Library file by ID.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> The file ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete folder by folder ID
>
> **Slug:** `GETRESPONSE_DELETE_FOLDER`
>
> Permanently delete a File Library folder by ID.
>
> #### Input Parameters
>
> **folder\_id** `string` *required*
>
> The folder ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete 'From' address
>
> **Slug:** `GETRESPONSE_DELETE_FROM_ADDRESS`
>
> Delete a GetResponse 'From' address, optionally replacing its references with another address.
>
> #### Input Parameters
>
> **from\_field\_id** `string` *required*
>
> The 'From' address ID to delete.
>
> **from\_field\_id\_to\_replace\_with** `string`
>
> Another 'From' address ID that should replace the deleted address where it is in use.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete meta field
>
> **Slug:** `GETRESPONSE_DELETE_META_FIELD`
>
> Delete a meta field from a shop.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **meta\_field\_id** `string` *required*
>
> The meta field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete newsletter
>
> **Slug:** `GETRESPONSE_DELETE_NEWSLETTER`
>
> Delete a newsletter by ID.
>
> #### Input Parameters
>
> **newsletter\_id** `string` *required*
>
> Newsletter ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete order
>
> **Slug:** `GETRESPONSE_DELETE_ORDER`
>
> Delete an order from a shop.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **order\_id** `string` *required*
>
> The order ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete a predefined field
>
> **Slug:** `GETRESPONSE_DELETE_PREDEFINED_FIELD`
>
> Delete an existing GetResponse predefined field.
>
> #### Input Parameters
>
> **predefined\_field\_id** `string` *required*
>
> The predefined field ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete product
>
> **Slug:** `GETRESPONSE_DELETE_PRODUCT`
>
> Delete a product from a shop.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete product variant
>
> **Slug:** `GETRESPONSE_DELETE_PRODUCT_VARIANT`
>
> Delete a product variant.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> **variant\_id** `string` *required*
>
> Variant ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete RSS newsletter
>
> **Slug:** `GETRESPONSE_DELETE_RSS_NEWSLETTER`
>
> Permanently delete an RSS newsletter.
>
> #### Input Parameters
>
> **rss\_newsletter\_id** `string` *required*
>
> RSS newsletter ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete search contacts
>
> **Slug:** `GETRESPONSE_DELETE_SAVED_CONTACT_SEARCH`
>
> Delete a saved contact search.
>
> #### Input Parameters
>
> **saved\_contact\_search\_id** `string` *required*
>
> Saved contact search ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete shop
>
> **Slug:** `GETRESPONSE_DELETE_SHOP`
>
> Delete an ecommerce shop.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete a suppression list
>
> **Slug:** `GETRESPONSE_DELETE_SUPPRESSION`
>
> Delete a suppression list by ID.
>
> #### Input Parameters
>
> **suppression\_id** `string` *required*
>
> The suppression list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete tag by ID
>
> **Slug:** `GETRESPONSE_DELETE_TAG`
>
> Delete a tag by ID.
>
> #### Input Parameters
>
> **tag\_id** `string` *required*
>
> The tag ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete tax by ID
>
> **Slug:** `GETRESPONSE_DELETE_TAX`
>
> Delete a tax from a shop.
>
> #### Input Parameters
>
> **tax\_id** `string` *required*
>
> The tax ID.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete transactional email template
>
> **Slug:** `GETRESPONSE_DELETE_TRANSACTIONAL_EMAIL_TEMPLATE`
>
> Permanently delete a transactional email template.
>
> #### Input Parameters
>
> **transactional\_email\_template\_id** `string` *required*
>
> Transactional email template ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable callbacks
>
> **Slug:** `GETRESPONSE_DISABLE_CALLBACKS`
>
> Disable all account-wide callbacks. Returns success=true for HTTP 204.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single A/B test
>
> **Slug:** `GETRESPONSE_GET_AB_TEST`
>
> Get a single A/B test by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **ab\_test\_id** `string` *required*
>
> A/B test ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Account information
>
> **Slug:** `GETRESPONSE_GET_ACCOUNT`
>
> Return information about the connected GetResponse account.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the account ID is always returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Current status of your GetResponse badge
>
> **Slug:** `GETRESPONSE_GET_ACCOUNT_BADGE`
>
> Return the current GetResponse badge status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Billing information
>
> **Slug:** `GETRESPONSE_GET_ACCOUNT_BILLING`
>
> Return billing, plan, allowance, payment, and add-on information.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated billing fields to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Returns account blocklist masks
>
> **Slug:** `GETRESPONSE_GET_ACCOUNT_BLOCKLIST`
>
> Returns account blocklist masks.
>
> #### Input Parameters
>
> **mask\_filter** `string`
>
> Blocklist mask to search for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get an address by ID
>
> **Slug:** `GETRESPONSE_GET_ADDRESS`
>
> Get one GetResponse account address by its ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **address\_id** `string` *required*
>
> The address ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get autoresponder
>
> **Slug:** `GETRESPONSE_GET_AUTORESPONDER`
>
> Get one autoresponder and its delivery and trigger settings.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **autoresponder\_id** `string` *required*
>
> Autoresponder ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get autoresponder statistics
>
> **Slug:** `GETRESPONSE_GET_AUTORESPONDER_STATISTICS`
>
> Return one page of delivery statistics for one autoresponder.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum statistics rows in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **group\_by\_filter** `string ("total" | "hour" | "day" | "month")`
>
> Time interval used to group statistics.
>
> **autoresponder\_id** `string`
>
> Autoresponder ID; required on the first page.
>
> **created\_on\_to\_filter** `string`
>
> Count data on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Count data on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get autoresponder thumbnail
>
> **Slug:** `GETRESPONSE_GET_AUTORESPONDER_THUMBNAIL`
>
> Download an autoresponder thumbnail image.
>
> #### Input Parameters
>
> **size** `string ("default" | "small")`
>
> Thumbnail size.
>
> **autoresponder\_id** `string` *required*
>
> Autoresponder ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get callbacks configuration
>
> **Slug:** `GETRESPONSE_GET_CALLBACK_CONFIGURATION`
>
> Get the account-wide callback configuration, including its URL and enabled event types. If callbacks are not configured, the request returns an error.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get campaign
>
> **Slug:** `GETRESPONSE_GET_CAMPAIGN`
>
> Get a campaign (contact list) by its campaign ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the campaign ID is always returned.
>
> **campaign\_id** `string` *required*
>
> Unique ID of the campaign (contact list).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get campaign blocklist
>
> **Slug:** `GETRESPONSE_GET_CAMPAIGN_BLOCKLIST`
>
> Return the blocklist masks configured for a campaign (contact list).
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> Unique ID of the campaign (contact list).
>
> **mask\_filter** `string`
>
> Blocklist mask to search for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get campaign statistics
>
> **Slug:** `GETRESPONSE_GET_CAMPAIGN_STATISTICS`
>
> Get one of six campaign metrics: subscriber origins, locations, list size, subscriptions, removals, or subscription-removal balance.
>
> #### Input Parameters
>
> **metric** `string ("origins" | "locations" | "list_size" | "subscriptions" | "removals" | "balance")` *required*
>
> Statistic to retrieve: origins, locations, list\_size, subscriptions, removals, or balance.
>
> **group\_by\_filter** `string ("total" | "hour" | "day" | "month")`
>
> Time grouping for the statistics.
>
> **campaign\_id\_filter** `string` *required*
>
> Campaign ID whose selected statistic should be returned.
>
> **created\_on\_to\_filter** `string`
>
> Inclusive end date or date-time for the statistics interval.
>
> **created\_on\_from\_filter** `string`
>
> Inclusive start date or date-time for the statistics interval.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get campaign statistics summary
>
> **Slug:** `GETRESPONSE_GET_CAMPAIGN_STATISTICS_SUMMARY`
>
> Get subscriber, newsletter, trigger, landing-page, and webform totals by campaign.
>
> #### Input Parameters
>
> **campaign\_id\_filter** `string`
>
> Optional campaign ID to limit the summary to one campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get cart by ID
>
> **Slug:** `GETRESPONSE_GET_CART`
>
> Get a cart and its selected variants by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **cart\_id** `string` *required*
>
> Cart ID.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single category by ID
>
> **Slug:** `GETRESPONSE_GET_CATEGORY`
>
> Get a category by shop ID and category ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **category\_id** `string` *required*
>
> The category ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get click tracked link details
>
> **Slug:** `GETRESPONSE_GET_CLICK_TRACK`
>
> Get click tracked link details by click-track ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **click\_track\_id** `string` *required*
>
> Click-track ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contact details by contact ID
>
> **Slug:** `GETRESPONSE_GET_CONTACT`
>
> Get contact details by contact ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **contact\_id** `string` *required*
>
> Unique contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a custom event by ID
>
> **Slug:** `GETRESPONSE_GET_CUSTOM_EVENT`
>
> Get a custom event definition by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **custom\_event\_id** `string` *required*
>
> Custom event ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a custom field
>
> **Slug:** `GETRESPONSE_GET_CUSTOM_FIELD`
>
> Get a custom field definition by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the custom field ID is always returned.
>
> **custom\_field\_id** `string` *required*
>
> The custom field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single custom report by ID
>
> **Slug:** `GETRESPONSE_GET_CUSTOM_REPORT`
>
> Get custom report status and generated files by ID. Requires a paid plan with custom reports.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **custom\_report\_id** `string` *required*
>
> Custom report ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the ecommerce general performance statistics
>
> **Slug:** `GETRESPONSE_GET_ECOMMERCE_PERFORMANCE`
>
> Get aggregate ecommerce order and revenue performance statistics.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **shop\_id\_filter** `string`
>
> Comma-separated shop IDs to include.
>
> **order\_date\_to\_filter** `string`
>
> Include orders through this YYYY-MM-DD date.
>
> **order\_date\_from\_filter** `string`
>
> Include orders from this YYYY-MM-DD date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the ecommerce revenue statistics
>
> **Slug:** `GETRESPONSE_GET_ECOMMERCE_REVENUE_STATISTICS`
>
> Get ecommerce revenue and order statistics over time.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **shop\_id\_filter** `string`
>
> Comma-separated shop IDs to include.
>
> **order\_date\_to\_filter** `string`
>
> Include orders through this YYYY-MM-DD date.
>
> **order\_date\_from\_filter** `string`
>
> Include orders from this YYYY-MM-DD date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get file by ID
>
> **Slug:** `GETRESPONSE_GET_FILE`
>
> Get File Library metadata and direct URLs for one file by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the file ID is always returned.
>
> **file\_id** `string` *required*
>
> The file ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get storage space information
>
> **Slug:** `GETRESPONSE_GET_FILE_LIBRARY_QUOTA`
>
> Get the File Library storage limit and current usage in bytes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get form by ID
>
> **Slug:** `GETRESPONSE_GET_FORM`
>
> Get a resource from GetResponse's standalone modern Forms product by form ID. This is distinct from the Forms and Popups resource family and requires the relevant paid plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **form\_id** `string` *required*
>
> Form ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single form or popup by ID
>
> **Slug:** `GETRESPONSE_GET_FORM_OR_POPUP`
>
> Get a resource from GetResponse's combined Forms and Popups product family by popup ID; use GET\_FORM for the separate standalone modern Forms family.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **popup\_id** `string` *required*
>
> Form or popup ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get statistics for a single form or popup
>
> **Slug:** `GETRESPONSE_GET_FORM_OR_POPUP_PERFORMANCE`
>
> Get performance statistics for an existing form or popup. Availability depends on the account plan.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **popup\_id** `string` *required*
>
> Form or popup ID.
>
> **device\_filter** `string ("desktop" | "mobile")`
>
> Filter statistics by device type.
>
> **date\_to\_filter** `string`
>
> End date for statistics in YYYY-MM-DD format.
>
> **location\_filter** `string`
>
> Filter statistics by location.
>
> **date\_from\_filter** `string`
>
> Start date for statistics in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single 'From' address by ID
>
> **Slug:** `GETRESPONSE_GET_FROM_ADDRESS`
>
> Get a single GetResponse 'From' address by its ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **from\_field\_id** `string` *required*
>
> The 'From' address ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get GDPR field details
>
> **Slug:** `GETRESPONSE_GET_GDPR_FIELD`
>
> Get a GetResponse GDPR field and its latest consent-text version.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **gdpr\_field\_id** `string` *required*
>
> The GDPR field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get an import by ID
>
> **Slug:** `GETRESPONSE_GET_IMPORT`
>
> Get import details and processing statistics by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **import\_id** `string` *required*
>
> Import ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single landing page by ID
>
> **Slug:** `GETRESPONSE_GET_LANDING_PAGE`
>
> Get a current landing page by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **landing\_page\_id** `string` *required*
>
> Landing page ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get details for landing page statistics
>
> **Slug:** `GETRESPONSE_GET_LANDING_PAGE_PERFORMANCE`
>
> Get performance statistics for an existing landing page. Availability depends on the account plan.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **page\_filter** `string`
>
> Filter statistics by landing page UUID.
>
> **device\_filter** `string ("desktop" | "mobile")`
>
> Filter statistics by device type.
>
> **date\_to\_filter** `string`
>
> End date or date-time for statistics.
>
> **landing\_page\_id** `string` *required*
>
> Landing page ID.
>
> **location\_filter** `string`
>
> Filter statistics by location.
>
> **date\_from\_filter** `string`
>
> Start date or date-time for statistics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Legacy Form by ID
>
> **Slug:** `GETRESPONSE_GET_LEGACY_FORM`
>
> Get a legacy form by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **webform\_id** `string` *required*
>
> Legacy form ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get single landing page by ID
>
> **Slug:** `GETRESPONSE_GET_LEGACY_LANDING_PAGE`
>
> Get a legacy landing page by ID. The response is an array of landing page details.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **landing\_page\_id** `string` *required*
>
> Legacy landing page ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the meta field by ID
>
> **Slug:** `GETRESPONSE_GET_META_FIELD`
>
> Get a meta field by shop ID and meta field ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **meta\_field\_id** `string` *required*
>
> The meta field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single newsletter
>
> **Slug:** `GETRESPONSE_GET_NEWSLETTER`
>
> Get a single newsletter by its ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **newsletter\_id** `string` *required*
>
> Newsletter ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get newsletter statistics
>
> **Slug:** `GETRESPONSE_GET_NEWSLETTER_STATISTICS`
>
> Return one page of statistics for a newsletter and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum statistics rows to return (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **newsletter\_id** `string`
>
> Newsletter ID; required on the first page.
>
> **group\_by\_filter** `string ("total" | "hour" | "day" | "month")`
>
> Group results by time interval.
>
> **created\_on\_to\_filter** `string`
>
> Count data on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Count data on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get newsletter thumbnail
>
> **Slug:** `GETRESPONSE_GET_NEWSLETTER_THUMBNAIL`
>
> Download a newsletter thumbnail with its provider content type.
>
> #### Input Parameters
>
> **size** `string ("default" | "small")`
>
> Thumbnail size.
>
> **newsletter\_id** `string` *required*
>
> Newsletter ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single order by ID
>
> **Slug:** `GETRESPONSE_GET_ORDER`
>
> Get one ecommerce order by its shop and order IDs.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **order\_id** `string` *required*
>
> The order ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a predefined field by ID
>
> **Slug:** `GETRESPONSE_GET_PREDEFINED_FIELD`
>
> Get detailed information about one GetResponse predefined field.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **predefined\_field\_id** `string` *required*
>
> The predefined field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single product by ID
>
> **Slug:** `GETRESPONSE_GET_PRODUCT`
>
> Get a product and its nested ecommerce data by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single product variant by ID
>
> **Slug:** `GETRESPONSE_GET_PRODUCT_VARIANT`
>
> Get a product variant and its nested ecommerce data by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> **variant\_id** `string` *required*
>
> Variant ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get RSS newsletter by ID
>
> **Slug:** `GETRESPONSE_GET_RSS_NEWSLETTER`
>
> Get one RSS newsletter and its delivery configuration.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **rss\_newsletter\_id** `string` *required*
>
> RSS newsletter ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get RSS newsletter statistics by ID
>
> **Slug:** `GETRESPONSE_GET_RSS_NEWSLETTER_STATISTICS`
>
> Return one page of delivery statistics for one RSS newsletter.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum statistics rows in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **group\_by\_filter** `string ("total" | "hour" | "day" | "month")`
>
> Time interval used to group statistics.
>
> **rss\_newsletter\_id** `string`
>
> RSS newsletter ID; required on the first page.
>
> **created\_on\_to\_filter** `string`
>
> Count data on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Count data on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get search contacts by contact ID
>
> **Slug:** `GETRESPONSE_GET_SAVED_CONTACT_SEARCH`
>
> Get a saved contact search by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **saved\_contact\_search\_id** `string` *required*
>
> Saved contact search ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send limits
>
> **Slug:** `GETRESPONSE_GET_SENDING_LIMITS`
>
> Return the connected account's email sending allowances and usage.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated sending-limit fields to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single shop by ID
>
> **Slug:** `GETRESPONSE_GET_SHOP`
>
> Get an ecommerce shop by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single automated SMS message by its ID
>
> **Slug:** `GETRESPONSE_GET_SMS_AUTOMATION_MESSAGE`
>
> Get an automated SMS message. Requires a paid SMS plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **sms\_id** `string` *required*
>
> Automated SMS message ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single SMS message by its ID
>
> **Slug:** `GETRESPONSE_GET_SMS_MESSAGE`
>
> Get an SMS message. Requires a paid SMS plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **sms\_id** `string` *required*
>
> SMS message ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get details for the SMS message statistics
>
> **Slug:** `GETRESPONSE_GET_SMS_STATISTICS`
>
> Get SMS message statistics. Requires a paid SMS plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **sms\_id** `string` *required*
>
> SMS message ID.
>
> **created\_on\_to\_filter** `string`
>
> End date for the statistics in ISO 8601 date format.
>
> **created\_on\_from\_filter** `string`
>
> Start date for the statistics in ISO 8601 date format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single subject A/B test
>
> **Slug:** `GETRESPONSE_GET_SUBJECT_AB_TEST`
>
> Get a single subject A/B test by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **ab\_test\_id** `string` *required*
>
> A/B test ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a suppression list by ID
>
> **Slug:** `GETRESPONSE_GET_SUPPRESSION`
>
> Get a suppression list by ID.
>
> #### Input Parameters
>
> **suppression\_id** `string` *required*
>
> The suppression list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get tag by ID
>
> **Slug:** `GETRESPONSE_GET_TAG`
>
> Get a tag by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the tag ID is always returned.
>
> **tag\_id** `string` *required*
>
> The tag ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single tax by ID
>
> **Slug:** `GETRESPONSE_GET_TAX`
>
> Get a tax by shop ID and tax ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **tax\_id** `string` *required*
>
> The tax ID.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get tracking JavaScript code snippets
>
> **Slug:** `GETRESPONSE_GET_TRACKING`
>
> Get the JavaScript snippets used to track purchases, abandoned carts, and visited URLs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get transactional email details by transactional email ID
>
> **Slug:** `GETRESPONSE_GET_TRANSACTIONAL_EMAIL`
>
> Get transactional email details by ID. Requires a paid transactional-email plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **transactional\_email\_id** `string` *required*
>
> Transactional email ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the overall statistics of transactional emails
>
> **Slug:** `GETRESPONSE_GET_TRANSACTIONAL_EMAIL_STATISTICS`
>
> Get aggregate transactional email statistics. Requires a paid transactional-email plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **tag\_id\_filter** `string`
>
> Filter by a specific tag ID.
>
> **tagged\_filter** `string ("true" | "false")`
>
> Filter by whether emails are tagged.
>
> **group\_by\_filter** `string ("total" | "day")` *required*
>
> Group statistics by total or day.
>
> **time\_frame\_to\_filter** `string`
>
> End of the statistics period as an ISO 8601 date or date-time.
>
> **time\_frame\_from\_filter** `string`
>
> Start of the statistics period as an ISO 8601 date or date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single template by ID
>
> **Slug:** `GETRESPONSE_GET_TRANSACTIONAL_EMAIL_TEMPLATE`
>
> Get a transactional email template by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **transactional\_email\_template\_id** `string` *required*
>
> Transactional email template ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a webinar by ID
>
> **Slug:** `GETRESPONSE_GET_WEBINAR`
>
> Get a webinar by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **webinar\_id** `string` *required*
>
> Webinar ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single Website by ID
>
> **Slug:** `GETRESPONSE_GET_WEBSITE`
>
> Get a website by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **website\_id** `string` *required*
>
> Website ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get details for website statistics
>
> **Slug:** `GETRESPONSE_GET_WEBSITE_PERFORMANCE`
>
> Get performance statistics for an existing website. Availability depends on the account plan.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **website\_id** `string` *required*
>
> Website ID.
>
> **page\_filter** `string`
>
> Filter statistics by website page UUID.
>
> **device\_filter** `string ("desktop" | "mobile")`
>
> Filter statistics by device type.
>
> **date\_to\_filter** `string`
>
> End date or date-time for statistics.
>
> **location\_filter** `string`
>
> Filter statistics by location.
>
> **date\_from\_filter** `string`
>
> Start date or date-time for statistics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a workflow by ID
>
> **Slug:** `GETRESPONSE_GET_WORKFLOW`
>
> Get a workflow and its subscriber statistics by ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **workflow\_id** `string` *required*
>
> Workflow ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List A/B tests
>
> **Slug:** `GETRESPONSE_LIST_AB_TESTS`
>
> Return one page of A/B tests and a continuation cursor. Results are filtered to active tests by default; the status filter can select inactive tests.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum tests to return (1-1000).
>
> **name\_filter** `string`
>
> Filter by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **type\_filter** `string`
>
> Filter by A/B test type.
>
> **status\_filter** `string ("active" | "inactive")`
>
> Filter by status.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **created\_on\_to\_filter** `string`
>
> Filter tests created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Filter tests created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] History of logins
>
> **Slug:** `GETRESPONSE_LIST_ACCOUNT_LOGINS`
>
> Return one page of account login history and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated login-history fields to return.
>
> **page\_size** `integer`
>
> Maximum login records to return in this page (1-1000).
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for page 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of addresses
>
> **Slug:** `GETRESPONSE_LIST_ADDRESSES`
>
> Return one filtered page of GetResponse addresses and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **page\_size** `integer`
>
> Maximum addresses to return in this page (1-1000).
>
> **zip\_filter** `string`
>
> Filter by ZIP or postal code.
>
> **city\_filter** `string`
>
> Filter by city.
>
> **name\_filter** `string`
>
> Filter addresses by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for the first page.
>
> **phone\_filter** `string`
>
> Filter by phone number.
>
> **company\_filter** `string`
>
> Filter by company name.
>
> **address1\_filter** `string`
>
> Filter by first address line.
>
> **address2\_filter** `string`
>
> Filter by second address line.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time in ascending or descending order.
>
> **province\_filter** `string`
>
> Filter by province or state name.
>
> **last\_name\_filter** `string`
>
> Filter by last name.
>
> **first\_name\_filter** `string`
>
> Filter by first name.
>
> **created\_on\_to\_filter** `string`
>
> Return addresses created on or before this ISO 8601 timestamp.
>
> **province\_code\_filter** `string`
>
> Filter by province or state code.
>
> **created\_on\_from\_filter** `string`
>
> Return addresses created on or after this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List autoresponders
>
> **Slug:** `GETRESPONSE_LIST_AUTORESPONDERS`
>
> Return one filtered page of autoresponders and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum autoresponders in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter autoresponders by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **subject\_sort** `string ("ASC" | "DESC")`
>
> Sort by subject.
>
> **status\_filter** `string ("enabled" | "disabled")`
>
> Filter autoresponders by status.
>
> **delivered\_sort** `string ("ASC" | "DESC")`
>
> Sort by delivered count.
>
> **open\_rate\_sort** `string ("ASC" | "DESC")`
>
> Sort by open rate.
>
> **subject\_filter** `string`
>
> Filter autoresponders by subject.
>
> **click\_rate\_sort** `string ("ASC" | "DESC")`
>
> Sort by click rate.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **day\_of\_cycle\_sort** `string ("ASC" | "DESC")`
>
> Sort by autoresponder cycle day.
>
> **campaign\_id\_filter** `string`
>
> Filter by campaign ID.
>
> **created\_on\_to\_filter** `string`
>
> Return autoresponders created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Return autoresponders created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List autoresponder statistics
>
> **Slug:** `GETRESPONSE_LIST_AUTORESPONDER_STATISTICS`
>
> Return one filtered page of statistics across autoresponders. Provide an autoresponder or campaign ID filter.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum statistics rows in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **group\_by\_filter** `string ("total" | "hour" | "day" | "month")`
>
> Time interval used to group statistics.
>
> **campaign\_id\_filter** `string`
>
> Comma-separated campaign IDs. Required unless autoresponder\_id\_filter is provided.
>
> **created\_on\_to\_filter** `string`
>
> Count data on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Count data on or after this ISO 8601 date or timestamp.
>
> **autoresponder\_id\_filter** `string`
>
> Comma-separated autoresponder IDs. Required unless campaign\_id\_filter is provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contacts from a single campaign
>
> **Slug:** `GETRESPONSE_LIST_CAMPAIGN_CONTACTS`
>
> List the contacts directly related to one campaign using the campaign-membership endpoint, with relationship-specific filters and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Name sort direction.
>
> **page\_size** `integer`
>
> Maximum contacts in this page (1-1000).
>
> **email\_sort** `string ("ASC" | "DESC")`
>
> Email sort direction.
>
> **campaign\_id** `string` *required*
>
> Campaign ID whose contacts to list.
>
> **name\_filter** `string`
>
> Filter contacts by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **email\_filter** `string`
>
> Filter contacts by email.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Creation-date sort direction.
>
> **created\_on\_to\_filter** `string`
>
> Created on or before this ISO 8601 value.
>
> **created\_on\_from\_filter** `string`
>
> Created on or after this ISO 8601 value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List campaigns
>
> **Slug:** `GETRESPONSE_LIST_CAMPAIGNS`
>
> Return one page of GetResponse campaigns (contact lists), with filters and sorting.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the campaign ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort campaign names in ascending or descending order.
>
> **page\_size** `integer`
>
> Maximum campaigns to return in this page (1-1000).
>
> **name\_filter** `string`
>
> Return campaigns whose names match this filter.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort campaign creation dates in ascending or descending order.
>
> **is\_default\_filter** `boolean`
>
> Filter campaigns by whether they are marked as default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get shop carts
>
> **Slug:** `GETRESPONSE_LIST_CARTS`
>
> Get one page of shop carts and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **page\_size** `integer`
>
> Maximum carts in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **external\_id\_filter** `string`
>
> Filter by external cart ID.
>
> **created\_on\_to\_filter** `string`
>
> Filter carts created on or before this date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Filter carts created on or after this date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the shop categories list
>
> **Slug:** `GETRESPONSE_LIST_CATEGORIES`
>
> Get one page of shop categories and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by category name.
>
> **page\_size** `integer`
>
> Maximum categories to return in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter categories by name.
>
> **next\_cursor** `string`
>
> Page cursor from a previous call; omit for the first page.
>
> **created\_at\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **parent\_id\_filter** `string`
>
> Filter categories by parent ID.
>
> **external\_id\_filter** `string`
>
> Filter categories by external ID.
>
> **search\_created\_at\_to** `string`
>
> Return categories created on or before this ISO 8601 timestamp.
>
> **search\_created\_at\_from** `string`
>
> Return categories created on or after this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List click tracked links
>
> **Slug:** `GETRESPONSE_LIST_CLICK_TRACKS`
>
> Return one page of click tracked links and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum links to return (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by message creation date.
>
> **created\_on\_to\_filter** `string`
>
> Filter links from messages created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Filter links from messages created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of contact activities
>
> **Slug:** `GETRESPONSE_LIST_CONTACT_ACTIVITIES`
>
> Get one page of contact activities and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum activities to return in this page (1-1000).
>
> **contact\_id** `string` *required*
>
> Unique contact ID.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **created\_on\_to\_filter** `string`
>
> Return activities created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Return activities created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contact's consent fields
>
> **Slug:** `GETRESPONSE_LIST_CONTACT_CONSENTS`
>
> Get the consent fields assigned to a contact.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **contact\_id** `string` *required*
>
> Unique contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contact list
>
> **Slug:** `GETRESPONSE_LIST_CONTACTS`
>
> Get one page of contacts and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Name sort direction.
>
> **page\_size** `integer`
>
> Maximum contacts in this page (1-1000).
>
> **email\_sort** `string ("ASC" | "DESC")`
>
> Email sort direction.
>
> **name\_filter** `string`
>
> Filter contacts by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **email\_filter** `string`
>
> Filter contacts by email.
>
> **origin\_filter** `string ("import" | "email" | "www" | "panel" | "leads" | "sale" | "api" | "survey" | "iphone" | "copy" | "landing_page" | "webinar" | "website_builder_elegant" | "chat" | "course" | "premium_newsletter")`
>
> Filter contacts by origin.
>
> **changed\_on\_sort** `string ("ASC" | "DESC")`
>
> Change-date sort direction.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Creation-date sort direction.
>
> **additional\_flags** `string`
>
> Set to exactMatch to require exact email and name matches.
>
> **campaign\_id\_sort** `string ("ASC" | "DESC")`
>
> Campaign-ID sort direction.
>
> **campaign\_id\_filter** `string`
>
> Filter contacts by campaign ID.
>
> **changed\_on\_to\_filter** `string`
>
> Changed on or before this ISO 8601 value.
>
> **created\_on\_to\_filter** `string`
>
> Created on or before this ISO 8601 value.
>
> **changed\_on\_from\_filter** `string`
>
> Changed on or after this ISO 8601 value.
>
> **created\_on\_from\_filter** `string`
>
> Created on or after this ISO 8601 value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List custom events
>
> **Slug:** `GETRESPONSE_LIST_CUSTOM_EVENTS`
>
> Return one filtered page of custom event definitions and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort custom events by name.
>
> **page\_size** `integer`
>
> Maximum custom events in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter custom events by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for page one.
>
> **has\_attributes\_filter** `string ("true" | "false")`
>
> Filter by whether custom events define attributes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of custom fields
>
> **Slug:** `GETRESPONSE_LIST_CUSTOM_FIELDS`
>
> Get one page of custom field definitions and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; custom field ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by custom field name.
>
> **page\_size** `integer`
>
> Maximum custom fields to return (1-1000).
>
> **name\_filter** `string`
>
> Filter custom fields by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of custom reports
>
> **Slug:** `GETRESPONSE_LIST_CUSTOM_REPORTS`
>
> Get one page of custom reports. Requires a paid plan with the custom-reports entitlement.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Name sort direction.
>
> **page\_size** `integer`
>
> Maximum reports in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter custom reports by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **frequency\_sort** `string ("ASC" | "DESC")`
>
> Frequency sort direction.
>
> **generated\_at\_sort** `string ("ASC" | "DESC")`
>
> Generation-date sort direction.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of Facebook Pixels
>
> **Slug:** `GETRESPONSE_LIST_FACEBOOK_PIXELS`
>
> List Facebook Pixels assigned to the connected GetResponse account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of files
>
> **Slug:** `GETRESPONSE_LIST_FILES`
>
> Return one page of File Library files with filters and sorting.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by file name.
>
> **page\_size** `integer`
>
> Maximum files to return in this page (1-1000).
>
> **size\_sort** `string ("ASC" | "DESC")`
>
> Sort by file size.
>
> **group\_sort** `string ("ASC" | "DESC")`
>
> Sort by media group.
>
> **name\_filter** `string`
>
> Filter files by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **group\_filter** `string ("audio" | "video" | "photo" | "document")`
>
> Filter files by media group.
>
> **folder\_id\_filter** `string`
>
> Return files from this folder only.
>
> **all\_folders\_filter** `string ("true" | "false")`
>
> Return files from all folders.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of folders
>
> **Slug:** `GETRESPONSE_LIST_FOLDERS`
>
> Return one page of File Library folders with filters and sorting.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by folder name.
>
> **page\_size** `integer`
>
> Maximum folders to return in this page (1-1000).
>
> **size\_sort** `string ("ASC" | "DESC")`
>
> Sort by folder size.
>
> **name\_filter** `string`
>
> Filter folders by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by folder creation date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of forms
>
> **Slug:** `GETRESPONSE_LIST_FORMS`
>
> Return one filtered page of modern forms and a continuation cursor. This endpoint requires the relevant paid GetResponse plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by form name.
>
> **page\_size** `integer`
>
> Maximum forms in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter forms by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for page one.
>
> **status\_filter** `string ("enabled" | "disabled" | "published" | "unpublished" | "draft")`
>
> Filter forms by publication status.
>
> **visitors\_sort** `string ("ASC" | "DESC")`
>
> Sort by visitor count.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time.
>
> **subscribed\_sort** `string ("ASC" | "DESC")`
>
> Sort by subscriber count.
>
> **campaign\_id\_filter** `string`
>
> Filter by one or more comma-separated campaign IDs.
>
> **created\_on\_to\_filter** `string`
>
> Filter forms created on or before this date or date-time.
>
> **unique\_visitors\_sort** `string ("ASC" | "DESC")`
>
> Sort by unique visitor count.
>
> **created\_on\_from\_filter** `string`
>
> Filter forms created on or after this date or date-time.
>
> **subscription\_rate\_sort** `string ("ASC" | "DESC")`
>
> Sort by subscription rate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List forms and popups
>
> **Slug:** `GETRESPONSE_LIST_FORMS_AND_POPUPS`
>
> Return one filtered page of forms and popups and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **ctr\_sort** `string ("ASC" | "DESC")`
>
> Sort by click-through rate.
>
> **stats\_to** `string`
>
> End date-time for embedded statistics.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum forms and popups in this page (1-1000).
>
> **leads\_sort** `string ("ASC" | "DESC")`
>
> Sort by lead count.
>
> **stats\_from** `string`
>
> Start date-time for embedded statistics.
>
> **views\_sort** `string ("ASC" | "DESC")`
>
> Sort by view count.
>
> **name\_filter** `string`
>
> Filter forms and popups by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for page one.
>
> **status\_sort** `string ("ASC" | "DESC")`
>
> Sort by status.
>
> **status\_filter** `string ("published" | "unpublished")`
>
> Filter forms and popups by status.
>
> **created\_at\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time.
>
> **updated\_at\_sort** `string ("ASC" | "DESC")`
>
> Sort by modification time.
>
> **unique\_visitors\_sort** `string ("ASC" | "DESC")`
>
> Sort by unique visitor count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of form variants (A/B tests)
>
> **Slug:** `GETRESPONSE_LIST_FORM_VARIANTS`
>
> Get all A/B test variants for a modern form. This endpoint requires the relevant paid GetResponse plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **form\_id** `string` *required*
>
> Form ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of 'From' addresses
>
> **Slug:** `GETRESPONSE_LIST_FROM_ADDRESSES`
>
> Return one filtered page of GetResponse 'From' addresses and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **page\_size** `integer`
>
> Maximum addresses to return in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter by sender name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for the first page.
>
> **email\_filter** `string`
>
> Filter by sender email address.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time in ascending or descending order.
>
> **is\_active\_filter** `boolean`
>
> Filter to active or inactive addresses.
>
> **is\_default\_filter** `boolean`
>
> Filter to default or non-default addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the GDPR fields list
>
> **Slug:** `GETRESPONSE_LIST_GDPR_FIELDS`
>
> Return one page of GetResponse GDPR fields and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by field name in ascending or descending order.
>
> **page\_size** `integer`
>
> Maximum GDPR fields to return in this page (1-1000).
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time in ascending or descending order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get images list
>
> **Slug:** `GETRESPONSE_LIST_IMAGES`
>
> Return one page of GetResponse Multimedia images.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum images to return in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List imports
>
> **Slug:** `GETRESPONSE_LIST_IMPORTS`
>
> Return one filtered page of contact imports and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **page\_size** `integer`
>
> Maximum imports in this page (1-1000).
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for page one.
>
> **status\_sort** `string ("ASC" | "DESC")`
>
> Sort by import status.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time.
>
> **finished\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by completion time.
>
> **campaign\_id\_filter** `string`
>
> Filter imports by destination campaign ID.
>
> **campaign\_name\_sort** `string ("ASC" | "DESC")`
>
> Sort by campaign name.
>
> **added\_contacts\_sort** `string ("ASC" | "DESC")`
>
> Sort by added contact count.
>
> **created\_on\_to\_filter** `string`
>
> Return imports created on or before this ISO 8601 value.
>
> **invalid\_contacts\_sort** `string ("ASC" | "DESC")`
>
> Sort by invalid contact count.
>
> **updated\_contacts\_sort** `string ("ASC" | "DESC")`
>
> Sort by updated contact count.
>
> **created\_on\_from\_filter** `string`
>
> Return imports created on or after this ISO 8601 value.
>
> **uploaded\_contacts\_sort** `string ("ASC" | "DESC")`
>
> Sort by uploaded contact count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List of Industry Tags
>
> **Slug:** `GETRESPONSE_LIST_INDUSTRIES`
>
> Return one page of industry tags and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated industry fields to return.
>
> **page\_size** `integer`
>
> Maximum industry tags to return in this page (1-1000).
>
> **next\_cursor** `string`
>
> Page-number continuation cursor returned by a previous call; omit for page 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of landing pages
>
> **Slug:** `GETRESPONSE_LIST_LANDING_PAGES`
>
> Return one filtered page of current landing pages and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **stats\_to** `string`
>
> End date-time for embedded statistics.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum landing pages in this page (1-1000).
>
> **leads\_sort** `string ("ASC" | "DESC")`
>
> Sort by lead count.
>
> **stats\_from** `string`
>
> Start date-time for embedded statistics.
>
> **name\_filter** `string`
>
> Filter landing pages by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for page one.
>
> **visits\_sort** `string ("ASC" | "DESC")`
>
> Sort by visit count.
>
> **status\_filter** `string ("published" | "unpublished")`
>
> Filter landing pages by status.
>
> **created\_at\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time.
>
> **updated\_at\_sort** `string ("ASC" | "DESC")`
>
> Sort by modification time.
>
> **subscription\_rate\_sort** `string ("ASC" | "DESC")`
>
> Sort by subscription rate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Legacy Forms
>
> **Slug:** `GETRESPONSE_LIST_LEGACY_FORMS`
>
> Return one filtered page of legacy forms and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **page\_size** `integer`
>
> Maximum legacy forms in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter legacy forms by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for page one.
>
> **modified\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by modification time.
>
> **campaign\_id\_filter** `string`
>
> Filter by one or more comma-separated campaign IDs.
>
> **modified\_on\_to\_filter** `string`
>
> Filter legacy forms modified on or before this date-time.
>
> **modified\_on\_from\_filter** `string`
>
> Filter legacy forms modified on or after this date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of landing pages
>
> **Slug:** `GETRESPONSE_LIST_LEGACY_LANDING_PAGES`
>
> Return one filtered page of legacy landing pages and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **page\_size** `integer`
>
> Maximum landing pages in this page (1-1000).
>
> **domain\_sort** `string ("ASC" | "DESC")`
>
> Sort by domain.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for page one.
>
> **domain\_filter** `string`
>
> Filter by domain.
>
> **status\_filter** `string ("enabled" | "disabled")`
>
> Filter by status.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time.
>
> **meta\_title\_sort** `string ("ASC" | "DESC")`
>
> Sort by metadata title.
>
> **campaign\_id\_sort** `string ("ASC" | "DESC")`
>
> Sort by campaign ID.
>
> **subdomain\_filter** `string`
>
> Filter by subdomain.
>
> **meta\_title\_filter** `string`
>
> Filter by metadata title.
>
> **campaign\_id\_filter** `string`
>
> Filter by one or more comma-separated encoded campaign IDs.
>
> **user\_domain\_filter** `string`
>
> Filter by a user-provided domain.
>
> **created\_on\_to\_filter** `string`
>
> Filter pages created on or before this date or date-time.
>
> **created\_on\_from\_filter** `string`
>
> Filter pages created on or after this date or date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the shop meta fields
>
> **Slug:** `GETRESPONSE_LIST_META_FIELDS`
>
> Get one page of shop meta fields and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **page\_size** `integer`
>
> Maximum meta fields to return in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter meta fields by name.
>
> **next\_cursor** `string`
>
> Page cursor from a previous call; omit for the first page.
>
> **value\_filter** `string`
>
> Filter meta fields by value.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **description\_filter** `string`
>
> Filter meta fields by description.
>
> **created\_on\_to\_filter** `string`
>
> Return meta fields created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Return meta fields created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List newsletters
>
> **Slug:** `GETRESPONSE_LIST_NEWSLETTERS`
>
> Return one page of newsletters and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum newsletters to return (1-1000).
>
> **name\_filter** `string`
>
> Filter by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **type\_filter** `string ("draft" | "broadcast" | "splittest" | "automation")`
>
> Filter by newsletter type.
>
> **send\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by send date.
>
> **status\_filter** `string ("enabled" | "disabled")`
>
> Filter by status.
>
> **subject\_filter** `string`
>
> Filter by subject.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **send\_on\_to\_filter** `string`
>
> Filter newsletters sent on or before this date.
>
> **campaign\_id\_filter** `string`
>
> Filter by campaign ID.
>
> **send\_on\_from\_filter** `string`
>
> Filter newsletters sent on or after this date.
>
> **created\_on\_to\_filter** `string`
>
> Filter newsletters created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Filter newsletters created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List newsletter statistics
>
> **Slug:** `GETRESPONSE_LIST_NEWSLETTER_STATISTICS`
>
> Return one page of total newsletter statistics and a continuation cursor. Provide a newsletter or campaign ID filter.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum statistics rows to return (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **group\_by\_filter** `string ("total" | "hour" | "day" | "month")`
>
> Group results by time interval.
>
> **campaign\_id\_filter** `string`
>
> Filter by campaign IDs in the provider's accepted string format. Required unless newsletter\_id\_filter is provided.
>
> **created\_on\_to\_filter** `string`
>
> Count data on or before this ISO 8601 date or timestamp.
>
> **newsletter\_id\_filter** `string`
>
> Filter by newsletter IDs in the provider's accepted string format. Required unless campaign\_id\_filter is provided.
>
> **created\_on\_from\_filter** `string`
>
> Count data on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of orders
>
> **Slug:** `GETRESPONSE_LIST_ORDERS`
>
> Get one page of orders and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **page\_size** `integer`
>
> Maximum orders in this page (1-1000).
>
> **next\_cursor** `string`
>
> Page cursor from a previous call; omit for the first page.
>
> **status\_filter** `string`
>
> Filter orders by status.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort orders by creation date.
>
> **description\_filter** `string`
>
> Filter orders by description.
>
> **external\_id\_filter** `string`
>
> Filter orders by external ID.
>
> **processed\_at\_to\_filter** `string`
>
> Include orders processed through this ISO 8601 time.
>
> **processed\_at\_from\_filter** `string`
>
> Include orders processed from this ISO 8601 time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the predefined fields list
>
> **Slug:** `GETRESPONSE_LIST_PREDEFINED_FIELDS`
>
> Return one filtered page of GetResponse predefined fields and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name in ascending or descending order.
>
> **page\_size** `integer`
>
> Maximum predefined fields to return in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter by predefined field name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **campaign\_id\_filter** `string`
>
> Filter by campaign ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a product list
>
> **Slug:** `GETRESPONSE_LIST_PRODUCTS`
>
> Get one page of products and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum products in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter by product name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **vendor\_filter** `string`
>
> Filter by vendor.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **category\_id\_filter** `string`
>
> Filter by category ID.
>
> **external\_id\_filter** `string`
>
> Filter by external product ID.
>
> **variant\_name\_filter** `string`
>
> Filter by variant name.
>
> **category\_name\_filter** `string`
>
> Filter by category name.
>
> **created\_on\_to\_filter** `string`
>
> Filter products created on or before this date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Filter products created on or after this date or timestamp.
>
> **meta\_field\_names\_filter** `string`
>
> Comma-separated meta field names.
>
> **meta\_field\_values\_filter** `string`
>
> Comma-separated meta field values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of product variants
>
> **Slug:** `GETRESPONSE_LIST_PRODUCT_VARIANTS`
>
> Get one page of product variants and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **page\_size** `integer`
>
> Maximum variants in this page (1-1000).
>
> **product\_id** `string` *required*
>
> Product ID.
>
> **sku\_filter** `string`
>
> Filter by stock-keeping unit.
>
> **name\_filter** `string`
>
> Filter by variant name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **description\_filter** `string`
>
> Filter by description.
>
> **external\_id\_filter** `string`
>
> Filter by external variant ID.
>
> **created\_at\_to\_filter** `string`
>
> Filter variants created on or before this timestamp.
>
> **created\_at\_from\_filter** `string`
>
> Filter variants created on or after this timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List RSS newsletters
>
> **Slug:** `GETRESPONSE_LIST_RSS_NEWSLETTERS`
>
> Return one filtered page of RSS newsletters and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **page\_size** `integer`
>
> Maximum RSS newsletters in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **status\_filter** `string ("enabled" | "disabled")`
>
> Filter RSS newsletters by status.
>
> **subject\_filter** `string`
>
> Filter RSS newsletters by subject.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **campaign\_id\_filter** `string`
>
> Filter by campaign ID.
>
> **created\_on\_to\_filter** `string`
>
> Return RSS newsletters created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Return RSS newsletters created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List RSS newsletter statistics
>
> **Slug:** `GETRESPONSE_LIST_RSS_NEWSLETTER_STATISTICS`
>
> Return one filtered page of statistics across RSS newsletters. Provide an RSS newsletter or campaign ID filter.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum statistics rows in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **group\_by\_filter** `string ("total" | "hour" | "day" | "month")`
>
> Time interval used to group statistics.
>
> **campaign\_id\_filter** `string`
>
> Comma-separated campaign IDs. Required unless rss\_newsletter\_id\_filter is provided.
>
> **created\_on\_to\_filter** `string`
>
> Count data on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Count data on or after this ISO 8601 date or timestamp.
>
> **rss\_newsletter\_id\_filter** `string`
>
> Comma-separated RSS newsletter IDs. Required unless campaign\_id\_filter is provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List saved contact searches
>
> **Slug:** `GETRESPONSE_LIST_SAVED_CONTACT_SEARCHES`
>
> Get one page of saved contact searches and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Name sort direction.
>
> **page\_size** `integer`
>
> Maximum saved searches in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter saved searches by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Creation-date sort direction.
>
> **created\_on\_to\_filter** `string`
>
> Created on or before this ISO 8601 value.
>
> **created\_on\_from\_filter** `string`
>
> Created on or after this ISO 8601 value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contacts by search contacts ID
>
> **Slug:** `GETRESPONSE_LIST_SAVED_SEARCH_CONTACTS`
>
> Get one page of contacts matching a saved contact search.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Name sort direction.
>
> **page\_size** `integer`
>
> Maximum contacts in this page (1-1000).
>
> **email\_sort** `string ("ASC" | "DESC")`
>
> Email sort direction.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Creation-date sort direction.
>
> **saved\_contact\_search\_id** `string` *required*
>
> Saved contact search ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of shops
>
> **Slug:** `GETRESPONSE_LIST_SHOPS`
>
> Get one page of shops and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by shop name.
>
> **page\_size** `integer`
>
> Maximum shops to return in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter shops by name.
>
> **next\_cursor** `string`
>
> Page cursor from a previous call; omit for the first page.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of automated SMS messages
>
> **Slug:** `GETRESPONSE_LIST_SMS_AUTOMATION_MESSAGES`
>
> Return one page of automated SMS messages. Requires a paid SMS plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum messages in this page (1-1000).
>
> **sent\_sort** `string ("ASC" | "DESC")`
>
> Sort by sent-message count.
>
> **clicks\_sort** `string ("ASC" | "DESC")`
>
> Sort by link-click count.
>
> **name\_filter** `string`
>
> Filter automated SMS messages by name.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for page one.
>
> **status\_sort** `string ("ASC" | "DESC")`
>
> Sort by status.
>
> **delivered\_sort** `string ("ASC" | "DESC")`
>
> Sort by delivered-message count.
>
> **has\_links\_filter** `boolean`
>
> Filter by whether the message contains links.
>
> **modified\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by modification date.
>
> **campaign\_id\_filter** `string`
>
> Filter by campaign ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of SMS messages
>
> **Slug:** `GETRESPONSE_LIST_SMS_MESSAGES`
>
> Return one page of SMS messages. Requires a paid SMS plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum messages in this page (1-1000).
>
> **sent\_sort** `string ("ASC" | "DESC")`
>
> Sort by sent-message count.
>
> **clicks\_sort** `string ("ASC" | "DESC")`
>
> Sort by link-click count.
>
> **name\_filter** `string`
>
> Filter SMS messages by name.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for page one.
>
> **type\_filter** `string ("sms" | "draft")`
>
> Filter by SMS message type.
>
> **send\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by sending date.
>
> **delivered\_sort** `string ("ASC" | "DESC")`
>
> Sort by delivered-message count.
>
> **has\_links\_filter** `boolean`
>
> Filter by whether the message contains links.
>
> **modified\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by modification date.
>
> **campaign\_id\_filter** `string`
>
> Filter by campaign ID.
>
> **sending\_status\_sort** `string ("ASC" | "DESC")`
>
> Sort by sending status.
>
> **sending\_status\_filter** `string ("scheduled" | "sending" | "sent")`
>
> Filter by sending status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of SMS sender names
>
> **Slug:** `GETRESPONSE_LIST_SMS_SENDER_NAMES`
>
> Get SMS sender names. Requires a paid SMS plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **status\_filter** `string ("pending" | "active" | "rejected")`
>
> Filter sender names by status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List subject A/B tests
>
> **Slug:** `GETRESPONSE_LIST_SUBJECT_AB_TESTS`
>
> Return one page of subject A/B tests and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum tests to return (1-1000).
>
> **stage\_sort** `string ("ASC" | "DESC")`
>
> Sort by stage.
>
> **name\_filter** `string`
>
> Filter by name.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **send\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by send date.
>
> **stage\_filter** `string ("preparing" | "testing" | "finished" | "sending-winner" | "cancelled" | "draft" | "completed")`
>
> Filter by stage.
>
> **ab\_test\_id\_filter** `string`
>
> Filter by one or more comma-separated A/B test IDs.
>
> **campaign\_id\_filter** `string`
>
> Filter by one or more comma-separated campaign IDs.
>
> **total\_delivered\_sort** `string ("ASC" | "DESC")`
>
> Sort by total delivered.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List subscription confirmation templates
>
> **Slug:** `GETRESPONSE_LIST_SUBSCRIPTION_CONFIRMATION_TEMPLATES`
>
> List unpaginated body or subject templates for subscription-confirmation emails in one language.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **language\_code** `string` *required*
>
> Language code for the confirmation templates, such as en.
>
> **template\_type** `string ("body" | "subject")` *required*
>
> Template family to list: body or subject.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get suppression lists
>
> **Slug:** `GETRESPONSE_LIST_SUPPRESSIONS`
>
> Get one page of suppression lists and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; suppression ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by suppression list name.
>
> **page\_size** `integer`
>
> Maximum suppression lists to return (1-1000).
>
> **name\_filter** `string`
>
> Filter suppression lists by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for the first page.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation timestamp.
>
> **created\_on\_to\_filter** `string`
>
> Return suppression lists created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Return suppression lists created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of tags
>
> **Slug:** `GETRESPONSE_LIST_TAGS`
>
> Get one page of tags and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; tag ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by tag name.
>
> **page\_size** `integer`
>
> Maximum tags to return (1-1000).
>
> **name\_filter** `string`
>
> Filter tags by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for the first page.
>
> **created\_at\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation timestamp.
>
> **created\_at\_to\_filter** `string`
>
> Return tags created on or before this ISO 8601 date or timestamp.
>
> **created\_at\_from\_filter** `string`
>
> Return tags created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a list of taxes
>
> **Slug:** `GETRESPONSE_LIST_TAXES`
>
> Get one page of taxes for a shop and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **page\_size** `integer`
>
> Maximum taxes to return in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter taxes by name.
>
> **next\_cursor** `string`
>
> Page cursor from a previous call; omit for the first page.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation date.
>
> **created\_on\_to\_filter** `string`
>
> Return taxes created on or before this ISO 8601 date or timestamp.
>
> **created\_on\_from\_filter** `string`
>
> Return taxes created on or after this ISO 8601 date or timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List of timezones
>
> **Slug:** `GETRESPONSE_LIST_TIMEZONES`
>
> List timezones in the connected account's language context.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated timezone fields to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of transactional emails
>
> **Slug:** `GETRESPONSE_LIST_TRANSACTIONAL_EMAILS`
>
> Get one page of transactional email history. Requires a paid transactional-email plan or add-on.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum emails in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **tag\_id\_filter** `string`
>
> Filter by a specific tag ID.
>
> **tagged\_filter** `string ("true" | "false")`
>
> Filter by whether emails are tagged.
>
> **sent\_on\_to\_filter** `string`
>
> Filter emails sent on or before this ISO 8601 date or date-time.
>
> **sent\_on\_from\_filter** `string`
>
> Filter emails sent on or after this ISO 8601 date or date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of transactional email templates
>
> **Slug:** `GETRESPONSE_LIST_TRANSACTIONAL_EMAIL_TEMPLATES`
>
> Get one page of transactional email templates and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **page\_size** `integer`
>
> Maximum templates in this page (1-1000).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **subject\_sort** `string ("ASC" | "DESC")`
>
> Subject sort direction.
>
> **subject\_filter** `string`
>
> Filter templates by subject.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Creation-date sort direction.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List webinars
>
> **Slug:** `GETRESPONSE_LIST_WEBINARS`
>
> Return one filtered page of webinars and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort webinars by name.
>
> **page\_size** `integer`
>
> Maximum webinars in this page (1-1000).
>
> **name\_filter** `string`
>
> Filter webinars by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for page one.
>
> **type\_filter** `string ("all" | "live" | "on_demand")`
>
> Filter webinars by type.
>
> **status\_filter** `string ("upcoming" | "finished" | "published" | "unpublished")`
>
> Filter webinars by status.
>
> **starts\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort webinars by start time.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Sort webinars by creation time.
>
> **campaign\_id\_filter** `string`
>
> Filter webinars by campaign ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get the list of websites
>
> **Slug:** `GETRESPONSE_LIST_WEBSITES`
>
> Return one filtered page of websites and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **stats\_to** `string`
>
> End date-time for embedded statistics.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Sort by name.
>
> **page\_size** `integer`
>
> Maximum websites in this page (1-1000).
>
> **stats\_from** `string`
>
> Start date-time for embedded statistics.
>
> **name\_filter** `string`
>
> Filter websites by name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for page one.
>
> **visits\_sort** `string ("ASC" | "DESC")`
>
> Sort by visit count.
>
> **status\_filter** `string ("published" | "unpublished")`
>
> Filter websites by status.
>
> **created\_at\_sort** `string ("ASC" | "DESC")`
>
> Sort by creation time.
>
> **page\_views\_sort** `string ("ASC" | "DESC")`
>
> Sort by page view count.
>
> **updated\_at\_sort** `string ("ASC" | "DESC")`
>
> Sort by modification time.
>
> **unique\_visitors\_sort** `string ("ASC" | "DESC")`
>
> Sort by unique visitor count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List workflows
>
> **Slug:** `GETRESPONSE_LIST_WORKFLOWS`
>
> Return one page of workflows and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return; the ID is always returned.
>
> **page\_size** `integer`
>
> Maximum workflows in this page (1-1000).
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for page one.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search contacts using conditions
>
> **Slug:** `GETRESPONSE_SEARCH_CONTACTS`
>
> Search contacts using supplied conditions without creating or changing a saved search. Returns one page and a continuation cursor.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated fields to return.
>
> **section** `array` *required*
>
> Contact search sections.
>
> **name\_sort** `string ("ASC" | "DESC")`
>
> Name sort direction.
>
> **page\_size** `integer`
>
> Maximum contacts in this page (1-1000).
>
> **email\_sort** `string ("ASC" | "DESC")`
>
> Email sort direction.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call.
>
> **created\_on\_sort** `string ("ASC" | "DESC")`
>
> Creation-date sort direction.
>
> **subscribers\_type** `array` *required*
>
> Subscription statuses included in the search.
>
> **section\_logic\_operator** `string ("or" | "and")` *required*
>
> Match any or all search sections.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Choose A/B test winner
>
> **Slug:** `GETRESPONSE_SELECT_SUBJECT_AB_TEST_WINNER`
>
> Choose the winning message variant for a subject A/B test.
>
> #### Input Parameters
>
> **ab\_test\_id** `string` *required*
>
> A/B test ID.
>
> **variant\_id** `string` *required*
>
> Message variant ID to select as the winner.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send newsletter draft
>
> **Slug:** `GETRESPONSE_SEND_NEWSLETTER_DRAFT`
>
> Send an existing newsletter draft using the supplied recipient and delivery settings.
>
> #### Input Parameters
>
> **message\_id** `string` *required*
>
> Newsletter draft ID.
>
> **send\_settings** `object` *required*
>
> Recipient selection and delivery settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send an SMS message
>
> **Slug:** `GETRESPONSE_SEND_SMS`
>
> Immediately send an SMS to selected GetResponse contacts or imported phone numbers. Requires a paid SMS plan or add-on.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> SMS message name.
>
> **content** `string` *required*
>
> SMS message content.
>
> **send\_settings** `object` *required*
>
> Sender and recipient settings for the selected recipients\_type.
>
> **recipients\_type** `string ("contacts" | "importedNumbers")` *required*
>
> Use contacts for GetResponse contacts or importedNumbers for manually supplied phone numbers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send transactional email
>
> **Slug:** `GETRESPONSE_SEND_TRANSACTIONAL_EMAIL`
>
> Send a direct or template-based transactional email. Requires a paid transactional-email plan or add-on.
>
> #### Input Parameters
>
> **tag** `object`
>
> Optional statistics tag.
>
> **content** `object`
>
> Body for a direct-content email.
>
> **subject** `string`
>
> Subject for a direct-content email.
>
> **reply\_to** `object`
>
> Reply-to address reference.
>
> **template** `object`
>
> Stored template for a template email.
>
> **from\_field** `object` *required*
>
> Sender address reference.
>
> **recipients** `object` *required*
>
> Message recipients; at most eight total recipients are supported.
>
> **attachments** `array`
>
> Files attached to the email.
>
> **content\_type** `string ("direct" | "template")`
>
> Whether to send direct content or a stored template.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set a 'From' address as default
>
> **Slug:** `GETRESPONSE_SET_DEFAULT_FROM_ADDRESS`
>
> Set an existing GetResponse 'From' address as the account default.
>
> #### Input Parameters
>
> **from\_field\_id** `string` *required*
>
> The 'From' address ID to make the account default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Trigger a custom event
>
> **Slug:** `GETRESPONSE_TRIGGER_CUSTOM_EVENT`
>
> Trigger an existing custom event for a contact. This may start connected automation workflows.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of an existing custom event.
>
> **attributes** `array`
>
> Values for attributes defined on the custom event.
>
> **contact\_id** `string` *required*
>
> Contact ID for which to trigger the event.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update account
>
> **Slug:** `GETRESPONSE_UPDATE_ACCOUNT`
>
> Update supplied profile fields on the connected GetResponse account. Provide at least one mutable field.
>
> #### Input Parameters
>
> **city** `string`
>
> City.
>
> **phone** `string`
>
> Phone number.
>
> **state** `string`
>
> State or region.
>
> **street** `string`
>
> Street address.
>
> **zip\_code** `string`
>
> Postal code.
>
> **last\_name** `string`
>
> Last name.
>
> **first\_name** `string`
>
> First name.
>
> **time\_format** `string ("12h" | "24h")`
>
> Account time notation.
>
> **company\_name** `string`
>
> Company name.
>
> **number\_of\_employees** `string ("50" | "250" | "500" | "more")`
>
> Company size bracket.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Turn on/off the GetResponse Badge
>
> **Slug:** `GETRESPONSE_UPDATE_ACCOUNT_BADGE`
>
> Enable or disable the selected GetResponse account badge type.
>
> #### Input Parameters
>
> **type** `string ("landing_page" | "website_builder_elegant" | "referral")`
>
> Account badge type.
>
> **status** `string ("enabled" | "disabled")` *required*
>
> Desired GetResponse badge status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update account blocklist
>
> **Slug:** `GETRESPONSE_UPDATE_ACCOUNT_BLOCKLIST`
>
> Update the account-wide blocklist. Omit additional\_flags to replace all masks; use add or delete for incremental changes, optionally combined with noResponse.
>
> #### Input Parameters
>
> **masks** `array` *required*
>
> Blocklist masks to add, delete, or replace.
>
> **additional\_flags** `array`
>
> Optional operation flags. Use add or delete to modify existing masks; use noResponse to ask GetResponse to omit response content. Provide multiple flags as a list; they are sent as one comma-separated value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update address
>
> **Slug:** `GETRESPONSE_UPDATE_ADDRESS`
>
> Update only the supplied fields of an existing GetResponse address. Provide at least one mutable field.
>
> #### Input Parameters
>
> **zip** `string`
>
> ZIP or postal code.
>
> **city** `string`
>
> City.
>
> **name** `string`
>
> Address label.
>
> **phone** `string`
>
> Phone number.
>
> **company** `string`
>
> Company name.
>
> **address1** `string`
>
> First street-address line.
>
> **address2** `string`
>
> Second street-address line.
>
> **province** `string`
>
> Province or state name.
>
> **last\_name** `string`
>
> Recipient last name.
>
> **address\_id** `string` *required*
>
> The address ID to update.
>
> **first\_name** `string`
>
> Recipient first name.
>
> **country\_code** `string`
>
> ISO 3166-1 alpha-3 country code.
>
> **province\_code** `string`
>
> Province or state code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update autoresponder
>
> **Slug:** `GETRESPONSE_UPDATE_AUTORESPONDER`
>
> Update an autoresponder's content, status, delivery timing, or trigger settings. Setting status to 'enabled' can send messages when its trigger conditions are met. Provide at least one mutable field.
>
> #### Input Parameters
>
> **name** `string`
>
> Autoresponder name.
>
> **flags** `array`
>
> Message tracking flags.
>
> **status** `string ("enabled" | "disabled")`
>
> Autoresponder status.
>
> **content** `object`
>
> Message content.
>
> **subject** `string`
>
> Autoresponder message subject.
>
> **reply\_to** `object`
>
> Reply-to address.
>
> **from\_field** `object`
>
> Sender address.
>
> **campaign\_id** `string`
>
> Campaign ID.
>
> **track\_opens** `string ("true" | "false")`
>
> Whether to track message opens.
>
> **send\_settings** `object`
>
> Delivery settings.
>
> **autoresponder\_id** `string` *required*
>
> Autoresponder ID to update.
>
> **trigger\_settings** `object`
>
> Autoresponder trigger conditions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable or update callbacks configuration
>
> **Slug:** `GETRESPONSE_UPDATE_CALLBACK_CONFIGURATION`
>
> Enable or update the account-wide callback URL and event subscriptions. Provide at least one mutable field.
>
> #### Input Parameters
>
> **url** `string`
>
> Notification URL; required when enabling callbacks for the first time.
>
> **actions** `object`
>
> Callback event types to enable or disable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update campaign
>
> **Slug:** `GETRESPONSE_UPDATE_CAMPAIGN`
>
> Update a GetResponse campaign (contact list) and its confirmation or profile settings.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique campaign (contact list) name.
>
> **postal** `object`
>
> Postal-address settings.
>
> **profile** `object`
>
> Public campaign profile settings.
>
> **is\_default** `string ("true" | "false")`
>
> Whether this campaign is the account default.
>
> **campaign\_id** `string` *required*
>
> Campaign ID to update.
>
> **optin\_types** `object`
>
> Opt-in settings by subscription source.
>
> **confirmation** `object`
>
> Subscription confirmation settings.
>
> **language\_code** `string`
>
> ISO 639-1 campaign language code, also accepting zt, fs, and md.
>
> **subscription\_notifications** `object`
>
> Subscription notification settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update campaign blocklist
>
> **Slug:** `GETRESPONSE_UPDATE_CAMPAIGN_BLOCKLIST`
>
> Add, delete, or replace blocklist masks for a campaign (contact list).
>
> #### Input Parameters
>
> **masks** `array` *required*
>
> Blocklist masks to add, delete, or replace.
>
> **campaign\_id** `string` *required*
>
> Unique ID of the campaign (contact list).
>
> **additional\_flags** `array`
>
> Optional operation flags. Use add or delete to modify existing masks; use noResponse to ask GetResponse to omit response content. Separate multiple flags in a list; they are serialized as a comma-separated value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update cart
>
> **Slug:** `GETRESPONSE_UPDATE_CART`
>
> Update a cart and its selected variants. Provide at least one mutable field.
>
> #### Input Parameters
>
> **cart\_id** `string` *required*
>
> Cart ID.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **cart\_url** `string`
>
> External cart URL.
>
> **currency** `string`
>
> ISO 4217 currency code.
>
> **contact\_id** `string`
>
> Contact ID that owns the cart.
>
> **external\_id** `string`
>
> External cart ID.
>
> **total\_price** `number`
>
> Total cart price excluding tax.
>
> **total\_tax\_price** `number`
>
> Total cart price including tax.
>
> **selected\_variants** `array`
>
> Variants selected in the cart.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update category
>
> **Slug:** `GETRESPONSE_UPDATE_CATEGORY`
>
> Update a category's supplied fields. Provide at least one mutable field.
>
> #### Input Parameters
>
> **url** `string`
>
> New external category URL.
>
> **name** `string`
>
> New category name.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **parent\_id** `string`
>
> New parent category ID.
>
> **is\_default** `boolean`
>
> Whether this is the default category.
>
> **category\_id** `string` *required*
>
> The category ID.
>
> **external\_id** `string`
>
> New external category ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update contact details
>
> **Slug:** `GETRESPONSE_UPDATE_CONTACT`
>
> Update contact details; supplied tags and custom fields replace existing values, and changing campaign moves the contact and its history. Provide at least one mutable field.
>
> #### Input Parameters
>
> **name** `string`
>
> New contact name.
>
> **note** `string`
>
> Contact note; null removes it.
>
> **tags** `array`
>
> Replacement set of contact tags.
>
> **email** `string`
>
> New contact email address.
>
> **scoring** `number`
>
> Contact score; null removes it.
>
> **campaign** `object`
>
> Campaign to move the contact to.
>
> **contact\_id** `string` *required*
>
> Unique contact ID.
>
> **day\_of\_cycle** `string`
>
> Autoresponder cycle day; null removes the contact from the cycle.
>
> **custom\_field\_values** `array`
>
> Replacement custom field values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a custom event
>
> **Slug:** `GETRESPONSE_UPDATE_CUSTOM_EVENT`
>
> Update a custom event definition and its attributes.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique custom event name.
>
> **attributes** `array` *required*
>
> Complete collection of attributes for the custom event.
>
> **custom\_event\_id** `string` *required*
>
> Custom event ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a custom field
>
> **Slug:** `GETRESPONSE_UPDATE_CUSTOM_FIELD`
>
> Update a custom field definition's visibility and assigned values.
>
> #### Input Parameters
>
> **hidden** `string ("true" | "false")` *required*
>
> Whether the custom field is visible to contacts, as a provider string boolean.
>
> **values** `array` *required*
>
> Complete list of values assigned to the custom field.
>
> **custom\_field\_id** `string` *required*
>
> The custom field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update meta field
>
> **Slug:** `GETRESPONSE_UPDATE_META_FIELD`
>
> Update a meta field's supplied fields. Provide at least one mutable field.
>
> #### Input Parameters
>
> **name** `string`
>
> New meta field name.
>
> **value** `string`
>
> New meta field value.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **value\_type** `string ("string" | "integer")`
>
> New meta field value type.
>
> **description** `string`
>
> New meta field description.
>
> **meta\_field\_id** `string` *required*
>
> The meta field ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update order
>
> **Slug:** `GETRESPONSE_UPDATE_ORDER`
>
> Update the supplied fields of an ecommerce order. Provide at least one mutable body field; additional\_flags alone does not update the order.
>
> #### Input Parameters
>
> **status** `string`
>
> New order status.
>
> **cart\_id** `string`
>
> New associated cart ID.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **currency** `string`
>
> New ISO 4217 currency code.
>
> **order\_id** `string` *required*
>
> The order ID.
>
> **order\_url** `string`
>
> New external order URL.
>
> **contact\_id** `string`
>
> New contact ID for the order.
>
> **description** `string`
>
> New order description.
>
> **external\_id** `string`
>
> New external order ID.
>
> **meta\_fields** `array`
>
> Complete replacement metadata collection for the order.
>
> **total\_price** `number`
>
> New total order price.
>
> **processed\_at** `string`
>
> New exact ISO 8601 time the order was made.
>
> **billing\_status** `string`
>
> New billing status.
>
> **shipping\_price** `number`
>
> New shipping price.
>
> **billing\_address** `object`
>
> Complete replacement billing address; individual fields cannot be patched.
>
> **total\_price\_tax** `number`
>
> New total order tax.
>
> **additional\_flags** `string`
>
> Use `skipAutomation` to avoid triggering Make a purchase workflows.
>
> **shipping\_address** `object`
>
> Complete replacement shipping address; individual fields cannot be patched.
>
> **selected\_variants** `array`
>
> Complete replacement selected-variant collection for the order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a predefined field
>
> **Slug:** `GETRESPONSE_UPDATE_PREDEFINED_FIELD`
>
> Update the value of an existing GetResponse predefined field.
>
> #### Input Parameters
>
> **value** `string` *required*
>
> New predefined field value containing only ASCII letters and underscores.
>
> **predefined\_field\_id** `string` *required*
>
> The predefined field ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update product
>
> **Slug:** `GETRESPONSE_UPDATE_PRODUCT`
>
> Update a product and its nested ecommerce data. Provide at least one mutable field.
>
> #### Input Parameters
>
> **url** `string`
>
> External product URL.
>
> **name** `string`
>
> Product name.
>
> **type** `string`
>
> Product type.
>
> **vendor** `string`
>
> Product vendor.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **variants** `array`
>
> Product variants.
>
> **categories** `array`
>
> Product categories.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> **external\_id** `string`
>
> External product ID.
>
> **meta\_fields** `array`
>
> Product meta fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update product variant
>
> **Slug:** `GETRESPONSE_UPDATE_PRODUCT_VARIANT`
>
> Update a product variant and its nested ecommerce data. Provide at least one mutable field.
>
> #### Input Parameters
>
> **sku** `string`
>
> Unique stock-keeping unit.
>
> **url** `string`
>
> External variant URL.
>
> **name** `string`
>
> Variant name.
>
> **price** `number`
>
> Price excluding tax.
>
> **taxes** `array`
>
> Variant taxes.
>
> **images** `array`
>
> Variant images.
>
> **barcode** `string`
>
> Variant barcode.
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **position** `integer`
>
> Variant position.
>
> **quantity** `integer`
>
> Available quantity.
>
> **price\_tax** `number`
>
> Price including tax.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> **variant\_id** `string` *required*
>
> Variant ID.
>
> **description** `string`
>
> Variant description.
>
> **external\_id** `string`
>
> External variant ID.
>
> **meta\_fields** `array`
>
> Variant meta fields.
>
> **previous\_price** `number`
>
> Previous price excluding tax.
>
> **previous\_price\_tax** `number`
>
> Previous price including tax.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update RSS newsletter
>
> **Slug:** `GETRESPONSE_UPDATE_RSS_NEWSLETTER`
>
> Update an RSS newsletter's content, status, delivery, or audience settings. Setting status to 'enabled' can send messages according to its delivery schedule. Provide at least one mutable field.
>
> #### Input Parameters
>
> **name** `string`
>
> Internal newsletter name.
>
> **flags** `array`
>
> Message tracking flags.
>
> **editor** `string ("custom" | "text" | "getresponse" | "legacy" | "html2")`
>
> Editor used to create the message.
>
> **status** `string ("enabled" | "disabled")`
>
> RSS newsletter status.
>
> **content** `object`
>
> Message content.
>
> **subject** `string`
>
> RSS message subject.
>
> **reply\_to** `object`
>
> Reply-to address.
>
> **from\_field** `object`
>
> Sender address.
>
> **rss\_feed\_url** `string`
>
> RSS feed URL.
>
> **send\_settings** `object`
>
> Delivery and audience settings.
>
> **rss\_newsletter\_id** `string` *required*
>
> RSS newsletter ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update search contacts
>
> **Slug:** `GETRESPONSE_UPDATE_SAVED_CONTACT_SEARCH`
>
> Replace a saved contact search's name and condition sections.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique saved-search name.
>
> **section** `array` *required*
>
> Replacement search sections.
>
> **subscribers\_type** `array`
>
> Subscription statuses included in the search.
>
> **section\_logic\_operator** `string ("or" | "and")` *required*
>
> Match any or all search sections.
>
> **saved\_contact\_search\_id** `string` *required*
>
> Saved contact search ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update shop
>
> **Slug:** `GETRESPONSE_UPDATE_SHOP`
>
> Update a shop's supplied fields. Provide at least one mutable field.
>
> #### Input Parameters
>
> **name** `string`
>
> New shop name.
>
> **locale** `string`
>
> New ISO 639-1 language locale.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> **currency** `string`
>
> New ISO 4217 currency code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a suppression list by ID
>
> **Slug:** `GETRESPONSE_UPDATE_SUPPRESSION`
>
> Replace a suppression list's masks and optionally rename it. The complete masks list is required; pass an empty list to remove all masks.
>
> #### Input Parameters
>
> **name** `string`
>
> The new suppression list name. Omit to keep the current name.
>
> **masks** `array` *required*
>
> Complete list of masks to assign to the suppression list.
>
> **suppression\_id** `string` *required*
>
> The suppression list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update tax
>
> **Slug:** `GETRESPONSE_UPDATE_TAX`
>
> Update a tax's supplied fields. Provide at least one mutable field.
>
> #### Input Parameters
>
> **name** `string`
>
> New tax name.
>
> **rate** `number`
>
> New tax rate.
>
> **tax\_id** `string` *required*
>
> The tax ID.
>
> **shop\_id** `string` *required*
>
> The shop ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update transactional email template
>
> **Slug:** `GETRESPONSE_UPDATE_TRANSACTIONAL_EMAIL_TEMPLATE`
>
> Update the subject or content of a transactional email template. Provide at least one mutable field.
>
> #### Input Parameters
>
> **content** `object`
>
> New plain-text and/or HTML content.
>
> **subject** `string`
>
> New template subject.
>
> **transactional\_email\_template\_id** `string` *required*
>
> Transactional email template ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a workflow
>
> **Slug:** `GETRESPONSE_UPDATE_WORKFLOW`
>
> Set a workflow to active, inactive, or incomplete (draft).
>
> #### Input Parameters
>
> **status** `string ("active" | "inactive" | "incomplete")` *required*
>
> New workflow status; incomplete represents a draft.
>
> **workflow\_id** `string` *required*
>
> Workflow ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload image
>
> **Slug:** `GETRESPONSE_UPLOAD_IMAGE`
>
> Upload an image file to GetResponse Multimedia.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> Required image file. Provider semantics override the optional OpenAPI marker.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert the custom fields of a contact
>
> **Slug:** `GETRESPONSE_UPSERT_CONTACT_CUSTOM_FIELDS`
>
> Add or update a contact's custom fields without removing other assigned custom fields.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> Unique contact ID.
>
> **custom\_field\_values** `array` *required*
>
> Custom fields to add or update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert the tags of a contact
>
> **Slug:** `GETRESPONSE_UPSERT_CONTACT_TAGS`
>
> Add tags to a contact without unassigning the contact's existing tags.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Tags to add without unassigning existing tags.
>
> **contact\_id** `string` *required*
>
> Unique contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert product meta fields
>
> **Slug:** `GETRESPONSE_UPSERT_META_FIELDS`
>
> Assign meta fields to a product without removing existing assignments.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> **meta\_fields** `array` *required*
>
> Meta fields to assign without removing existing assignments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert product categories
>
> **Slug:** `GETRESPONSE_UPSERT_PRODUCT_CATEGORIES`
>
> Assign categories to a product and optionally set its default category without removing existing assignments.
>
> #### Input Parameters
>
> **shop\_id** `string` *required*
>
> Shop ID.
>
> **categories** `array` *required*
>
> Categories to assign without removing existing assignments.
>
> **product\_id** `string` *required*
>
> Product ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert custom fields by search contacts
>
> **Slug:** `GETRESPONSE_UPSERT_SAVED_SEARCH_CONTACT_CUSTOM_FIELDS`
>
> Submit an asynchronous request to add or update custom fields for contacts matching a saved contact search. A successful response confirms acceptance, not completion.
>
> #### Input Parameters
>
> **custom\_field\_values** `array` *required*
>
> Custom fields to add or update on matching contacts.
>
> **saved\_contact\_search\_id** `string` *required*
>
> Saved contact search ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
