---
canonical_url: "https://docs.composio.dev/toolkits/getresponse"
markdown_url: "https://docs.composio.dev/toolkits/getresponse.md"
product: "platform"
version: null
last_updated: null
---

# GetResponse

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

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

## Tools

### Cancel A/B test

**Slug:** `GETRESPONSE_CANCEL_AB_TEST`

Schedule cancellation of an A/B test.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ab_test_id` | string | Yes | A/B test ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel sending the newsletter

**Slug:** `GETRESPONSE_CANCEL_NEWSLETTER_SEND`

Cancel newsletter sending and turn the newsletter into a draft.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `newsletter_id` | string | Yes | Newsletter ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create address

**Slug:** `GETRESPONSE_CREATE_ADDRESS`

Create an address in the connected GetResponse account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zip` | string | No | ZIP or postal code. |
| `city` | string | No | City. |
| `name` | string | Yes | Address label. |
| `phone` | string | No | Phone number. |
| `company` | string | No | Company name. |
| `address1` | string | No | First street-address line. |
| `address2` | string | No | Second street-address line. |
| `province` | string | No | Province or state name. |
| `last_name` | string | No | Recipient last name. |
| `first_name` | string | No | Recipient first name. |
| `country_code` | string | Yes | ISO 3166-1 alpha-3 country code. |
| `province_code` | string | No | Province or state code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Newsletter name. |
| `flags` | array | No | Message tracking flags. |
| `content` | object | Yes | Newsletter message content. |
| `subject` | string | Yes | Message subject. |
| `campaign` | object | Yes | Campaign assigned to the newsletter. |
| `reply_to` | object | No | Reply-to email address. |
| `from_field` | object | Yes | From email address. |
| `attachments` | array | No | Base64 attachments; combined size must not exceed 400 KB. |
| `track_opens` | string ("true" | "false") | No | Whether opens are tracked; defaults to true upstream. |
| `send_settings` | object | Yes | Recipient and delivery settings required by GetResponse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create autoresponder

**Slug:** `GETRESPONSE_CREATE_AUTORESPONDER`

Create an autoresponder that automatically delivers its message when the configured trigger and timing conditions are met.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Autoresponder name. |
| `flags` | array | No | Message tracking flags. |
| `status` | string ("enabled" | "disabled") | Yes | Autoresponder status. |
| `content` | object | Yes | Message content. |
| `subject` | string | Yes | Autoresponder message subject. |
| `reply_to` | object | No | Reply-to address. |
| `from_field` | object | No | Sender address. |
| `campaign_id` | string | No | Campaign ID; omitted uses the default campaign. |
| `track_opens` | string ("true" | "false") | No | Whether to track message opens. |
| `send_settings` | object | Yes | Delivery settings. |
| `trigger_settings` | object | Yes | Autoresponder trigger conditions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique campaign (contact list) name. |
| `postal` | object | No | Postal-address settings. |
| `profile` | object | No | Public campaign profile settings. |
| `is_default` | string ("true" | "false") | No | Whether this should be the default campaign. |
| `optin_types` | object | No | Opt-in settings by subscription source. |
| `confirmation` | object | No | Subscription confirmation settings. |
| `language_code` | string | No | ISO 639-1 campaign language code, also accepting zt, fs, and md. |
| `subscription_notifications` | object | No | Subscription notification settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create cart

**Slug:** `GETRESPONSE_CREATE_CART`

Create a cart with its selected product variants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | Shop ID. |
| `cart_url` | string | No | External cart URL. |
| `currency` | string | Yes | ISO 4217 currency code. |
| `contact_id` | string | Yes | Contact ID that owns the cart. |
| `external_id` | string | No | External cart ID. |
| `total_price` | number | Yes | Total cart price excluding tax. |
| `total_tax_price` | number | No | Total cart price including tax. |
| `selected_variants` | array | Yes | Variants selected in the cart. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | External URL for the category. |
| `name` | string | Yes | The category name. |
| `shop_id` | string | Yes | The shop ID. |
| `parent_id` | string | No | The parent category ID. |
| `is_default` | boolean | No | Whether this is the default category. |
| `external_id` | string | No | Category ID assigned by another system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Contact name. |
| `tags` | array | No | Tags to assign to the contact. |
| `email` | string | Yes | Contact email address. |
| `scoring` | number | No | Contact score; null removes the score. |
| `campaign` | object | Yes | Campaign in which to create the contact. |
| `ip_address` | string | No | Contact IPv4 or IPv6 address. |
| `day_of_cycle` | string | No | Autoresponder cycle day; null means not in the cycle. |
| `custom_field_values` | array | No | Custom field values to assign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | Contacts to create (1-1000 contacts per batch). |
| `campaign_id` | string | Yes | Destination campaign ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a custom event

**Slug:** `GETRESPONSE_CREATE_CUSTOM_EVENT`

Create a custom event definition with typed attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique custom event name. |
| `attributes` | array | Yes | Attributes defined for the custom event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a custom field

**Slug:** `GETRESPONSE_CREATE_CUSTOM_FIELD`

Create a custom field definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique lowercase custom field name using only letters, digits, and underscores. |
| `type` | string ("string" | "number" | "date" | "datetime" | "country" | "currency" | "phone" | "gender" | "ip" | "url") | Yes | The data type accepted by the custom field. |
| `format` | string ("text" | "textarea" | "radio" | "checkbox" | "single_select" | "multi_select") | Yes | The input format used by the custom field. |
| `hidden` | string ("true" | "false") | Yes | Whether the custom field is visible to contacts, as a provider string boolean. |
| `values` | array | Yes | Default choices; radio and select formats require at least two values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | 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") | Yes | Custom report type; availability varies by pricing plan. |
| `filters` | object | No | Required message activity filters; valid only for message_activity_report. |
| `scheduling` | object | Yes | One-time reporting period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a file

**Slug:** `GETRESPONSE_CREATE_FILE`

Create a File Library file from base64-encoded content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | File name. |
| `folder` | string | Yes | Folder in which to store the file, or null for the root-folder mode. |
| `content` | string | Yes | Base64-encoded file bytes, without a data URL prefix. |
| `extension` | string | Yes | File extension without a leading dot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a folder

**Slug:** `GETRESPONSE_CREATE_FOLDER`

Create a File Library folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Folder name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create 'From' address

**Slug:** `GETRESPONSE_CREATE_FROM_ADDRESS`

Create a GetResponse sender name and email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name associated with the sender email address. |
| `email` | string | Yes | Email address to use as a sender. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a contact import

**Slug:** `GETRESPONSE_CREATE_IMPORT`

Start an asynchronous contact import into a campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | Contact rows whose values correspond positionally to field_mapping. |
| `campaign_id` | string | Yes | ID of the destination campaign (contact list). |
| `field_mapping` | array | Yes | Column mapping for each contact row. Include email and custom field names in row order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create meta field

**Slug:** `GETRESPONSE_CREATE_META_FIELD`

Create a meta field in a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The meta field name. |
| `value` | string | Yes | The meta field value. |
| `shop_id` | string | Yes | The shop ID. |
| `value_type` | string ("string" | "integer") | Yes | The meta field value type. |
| `description` | string | No | The meta field description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Newsletter name. |
| `flags` | array | No | Message tracking flags. |
| `content` | object | Yes | Newsletter message content. |
| `subject` | string | Yes | Message subject. |
| `campaign` | object | Yes | Campaign assigned to the newsletter. |
| `reply_to` | object | No | Reply-to email address. |
| `from_field` | object | Yes | From email address. |
| `attachments` | array | No | Base64 attachments; combined size must not exceed 400 KB. |
| `track_opens` | string ("true" | "false") | No | Whether opens are tracked; defaults to true upstream. |
| `send_settings` | object | Yes | Recipient and delivery settings required by GetResponse. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create order

**Slug:** `GETRESPONSE_CREATE_ORDER`

Create an ecommerce order and trigger matching Make a purchase workflows unless additional_flags is skipAutomation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string | No | Order status. |
| `cart_id` | string | No | Associated cart ID. |
| `shop_id` | string | Yes | The shop ID. |
| `currency` | string | Yes | ISO 4217 order currency code. |
| `order_url` | string | No | External URL for the order. |
| `contact_id` | string | Yes | ID of the contact placing the order. |
| `description` | string | No | Order description. |
| `external_id` | string | No | Order ID assigned by another system. |
| `meta_fields` | array | No | Order metadata fields. |
| `total_price` | number | Yes | Total order price. |
| `processed_at` | string | No | Exact ISO 8601 time the order was made. |
| `billing_status` | string | No | Order billing status. |
| `shipping_price` | number | No | Shipping price. |
| `billing_address` | object | No | Complete billing address. |
| `total_price_tax` | number | No | Total order tax. |
| `additional_flags` | string | No | Use `skipAutomation` to avoid triggering Make a purchase workflows. |
| `shipping_address` | object | No | Complete shipping address. |
| `selected_variants` | array | Yes | Selected product variants in the order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a predefined field

**Slug:** `GETRESPONSE_CREATE_PREDEFINED_FIELD`

Create a campaign-specific predefined field in GetResponse.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Predefined field name containing letters, numbers, and underscores. |
| `value` | string | Yes | Value substituted for the predefined field. |
| `campaign` | object | Yes | Campaign associated with the predefined field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create product

**Slug:** `GETRESPONSE_CREATE_PRODUCT`

Create a product and its nested ecommerce data in a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | External product URL. |
| `name` | string | Yes | Product name. |
| `type` | string | No | Product type. |
| `vendor` | string | No | Product vendor. |
| `shop_id` | string | Yes | Shop ID. |
| `variants` | array | Yes | Product variants. |
| `categories` | array | No | Product categories. |
| `external_id` | string | No | External product ID. |
| `meta_fields` | array | No | Product meta fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create product variant

**Slug:** `GETRESPONSE_CREATE_PRODUCT_VARIANT`

Create a product variant with images, meta fields, and taxes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | Yes | Unique stock-keeping unit. |
| `url` | string | No | External variant URL. |
| `name` | string | Yes | Variant name. |
| `price` | number | Yes | Price excluding tax. |
| `taxes` | array | No | Variant taxes. |
| `images` | array | No | Variant images. |
| `barcode` | string | No | Variant barcode. |
| `shop_id` | string | Yes | Shop ID. |
| `position` | integer | No | Variant position. |
| `quantity` | integer | No | Available quantity. |
| `price_tax` | number | Yes | Price including tax. |
| `product_id` | string | Yes | Product ID. |
| `description` | string | No | Variant description. |
| `external_id` | string | No | External variant ID. |
| `meta_fields` | array | No | Variant meta fields. |
| `previous_price` | number | No | Previous price excluding tax. |
| `previous_price_tax` | number | No | Previous price including tax. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Internal newsletter name. |
| `flags` | array | No | Message tracking flags. |
| `editor` | string ("custom" | "text" | "getresponse" | "legacy" | "html2") | No | Editor used to create the message. |
| `status` | string ("enabled" | "disabled") | Yes | RSS newsletter status. |
| `content` | object | Yes | Message content. |
| `subject` | string | Yes | RSS message subject. |
| `reply_to` | object | No | Reply-to address. |
| `from_field` | object | Yes | Sender address. |
| `rss_feed_url` | string | Yes | RSS feed URL. |
| `send_settings` | object | Yes | Delivery and audience settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create search contacts

**Slug:** `GETRESPONSE_CREATE_SAVED_CONTACT_SEARCH`

Create a saved contact search from condition sections.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique saved-search name. |
| `section` | array | Yes | Search sections to save. |
| `subscribers_type` | array | No | Subscription statuses included in the search. |
| `section_logic_operator` | string ("or" | "and") | Yes | Match any or all search sections. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create shop

**Slug:** `GETRESPONSE_CREATE_SHOP`

Create an ecommerce shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The shop name. |
| `locale` | string | Yes | ISO 639-1 language locale. |
| `currency` | string | Yes | ISO 4217 currency code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A/B test name. |
| `flags` | array | No | Tracking options enabled for the test. |
| `content` | object | Yes | Message content shared by the variants. |
| `campaign` | object | Yes | Campaign assigned to the A/B test. |
| `reply_to` | object | No | Reply-to address. |
| `variants` | array | Yes | Two to five subject variants, each no longer than 150 characters. |
| `from_field` | object | Yes | From address used by the variants. |
| `send_settings` | object | Yes | Recipient selection settings. |
| `delivery_settings` | object | Yes | A/B test delivery settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a suppression list

**Slug:** `GETRESPONSE_CREATE_SUPPRESSION`

Create a new suppression list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The suppression list name. |
| `masks` | array | No | Masks to add to the suppression list, such as email addresses or domains. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a new tag

**Slug:** `GETRESPONSE_CREATE_TAG`

Add a new tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tag name containing only letters, digits, and underscores. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create tax

**Slug:** `GETRESPONSE_CREATE_TAX`

Create a tax for a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The tax name. |
| `rate` | number | Yes | The tax rate. |
| `shop_id` | string | Yes | The shop ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create transactional email template

**Slug:** `GETRESPONSE_CREATE_TRANSACTIONAL_EMAIL_TEMPLATE`

Create a reusable transactional email template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | object | No | Optional plain-text and/or HTML template content. |
| `subject` | string | Yes | Template subject. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete A/B test

**Slug:** `GETRESPONSE_DELETE_AB_TEST`

Delete an A/B test.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ab_test_id` | string | Yes | A/B test ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete address

**Slug:** `GETRESPONSE_DELETE_ADDRESS`

Delete an existing GetResponse account address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | string | Yes | The address ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete autoresponder

**Slug:** `GETRESPONSE_DELETE_AUTORESPONDER`

Permanently delete an autoresponder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `autoresponder_id` | string | Yes | Autoresponder ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete cart

**Slug:** `GETRESPONSE_DELETE_CART`

Delete a cart from a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cart_id` | string | Yes | Cart ID. |
| `shop_id` | string | Yes | Shop ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete category

**Slug:** `GETRESPONSE_DELETE_CATEGORY`

Delete a category from a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | The shop ID. |
| `category_id` | string | Yes | The category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique contact ID. |
| `ip_address` | string | No | IPv4 address from which the contact unsubscribed; use with message_id. |
| `message_id` | string | No | Message ID used to simulate an unsubscribe from that message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a custom event

**Slug:** `GETRESPONSE_DELETE_CUSTOM_EVENT`

Delete a custom event definition by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_event_id` | string | Yes | Custom event ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a custom field

**Slug:** `GETRESPONSE_DELETE_CUSTOM_FIELD`

Delete a custom field definition by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_id` | string | Yes | The custom field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete file by file ID

**Slug:** `GETRESPONSE_DELETE_FILE`

Permanently delete a File Library file by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | string | Yes | The file ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete folder by folder ID

**Slug:** `GETRESPONSE_DELETE_FOLDER`

Permanently delete a File Library folder by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | The folder ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete 'From' address

**Slug:** `GETRESPONSE_DELETE_FROM_ADDRESS`

Delete a GetResponse 'From' address, optionally replacing its references with another address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from_field_id` | string | Yes | The 'From' address ID to delete. |
| `from_field_id_to_replace_with` | string | No | Another 'From' address ID that should replace the deleted address where it is in use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete meta field

**Slug:** `GETRESPONSE_DELETE_META_FIELD`

Delete a meta field from a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | The shop ID. |
| `meta_field_id` | string | Yes | The meta field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete newsletter

**Slug:** `GETRESPONSE_DELETE_NEWSLETTER`

Delete a newsletter by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `newsletter_id` | string | Yes | Newsletter ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete order

**Slug:** `GETRESPONSE_DELETE_ORDER`

Delete an order from a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | The shop ID. |
| `order_id` | string | Yes | The order ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a predefined field

**Slug:** `GETRESPONSE_DELETE_PREDEFINED_FIELD`

Delete an existing GetResponse predefined field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `predefined_field_id` | string | Yes | The predefined field ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete product

**Slug:** `GETRESPONSE_DELETE_PRODUCT`

Delete a product from a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | Shop ID. |
| `product_id` | string | Yes | Product ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete product variant

**Slug:** `GETRESPONSE_DELETE_PRODUCT_VARIANT`

Delete a product variant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | Shop ID. |
| `product_id` | string | Yes | Product ID. |
| `variant_id` | string | Yes | Variant ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete RSS newsletter

**Slug:** `GETRESPONSE_DELETE_RSS_NEWSLETTER`

Permanently delete an RSS newsletter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rss_newsletter_id` | string | Yes | RSS newsletter ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete search contacts

**Slug:** `GETRESPONSE_DELETE_SAVED_CONTACT_SEARCH`

Delete a saved contact search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `saved_contact_search_id` | string | Yes | Saved contact search ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete shop

**Slug:** `GETRESPONSE_DELETE_SHOP`

Delete an ecommerce shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | The shop ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a suppression list

**Slug:** `GETRESPONSE_DELETE_SUPPRESSION`

Delete a suppression list by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `suppression_id` | string | Yes | The suppression list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete tag by ID

**Slug:** `GETRESPONSE_DELETE_TAG`

Delete a tag by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | The tag ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete tax by ID

**Slug:** `GETRESPONSE_DELETE_TAX`

Delete a tax from a shop.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_id` | string | Yes | The tax ID. |
| `shop_id` | string | Yes | The shop ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete transactional email template

**Slug:** `GETRESPONSE_DELETE_TRANSACTIONAL_EMAIL_TEMPLATE`

Permanently delete a transactional email template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transactional_email_template_id` | string | Yes | Transactional email template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable callbacks

**Slug:** `GETRESPONSE_DISABLE_CALLBACKS`

Disable all account-wide callbacks. Returns success=true for HTTP 204.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single A/B test

**Slug:** `GETRESPONSE_GET_AB_TEST`

Get a single A/B test by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `ab_test_id` | string | Yes | A/B test ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Account information

**Slug:** `GETRESPONSE_GET_ACCOUNT`

Return information about the connected GetResponse account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the account ID is always returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Current status of your GetResponse badge

**Slug:** `GETRESPONSE_GET_ACCOUNT_BADGE`

Return the current GetResponse badge status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Billing information

**Slug:** `GETRESPONSE_GET_ACCOUNT_BILLING`

Return billing, plan, allowance, payment, and add-on information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated billing fields to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Returns account blocklist masks

**Slug:** `GETRESPONSE_GET_ACCOUNT_BLOCKLIST`

Returns account blocklist masks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mask_filter` | string | No | Blocklist mask to search for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get an address by ID

**Slug:** `GETRESPONSE_GET_ADDRESS`

Get one GetResponse account address by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `address_id` | string | Yes | The address ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get autoresponder

**Slug:** `GETRESPONSE_GET_AUTORESPONDER`

Get one autoresponder and its delivery and trigger settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `autoresponder_id` | string | Yes | Autoresponder ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get autoresponder statistics

**Slug:** `GETRESPONSE_GET_AUTORESPONDER_STATISTICS`

Return one page of delivery statistics for one autoresponder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum statistics rows in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `group_by_filter` | string ("total" | "hour" | "day" | "month") | No | Time interval used to group statistics. |
| `autoresponder_id` | string | No | Autoresponder ID; required on the first page. |
| `created_on_to_filter` | string | No | Count data on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Count data on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get autoresponder thumbnail

**Slug:** `GETRESPONSE_GET_AUTORESPONDER_THUMBNAIL`

Download an autoresponder thumbnail image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string ("default" | "small") | No | Thumbnail size. |
| `autoresponder_id` | string | Yes | Autoresponder ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get callbacks configuration

**Slug:** `GETRESPONSE_GET_CALLBACK_CONFIGURATION`

Return whether account-wide callbacks are configured, plus their URL and enabled event types when configured.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get campaign

**Slug:** `GETRESPONSE_GET_CAMPAIGN`

Get a campaign (contact list) by its campaign ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the campaign ID is always returned. |
| `campaign_id` | string | Yes | Unique ID of the campaign (contact list). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get campaign blocklist

**Slug:** `GETRESPONSE_GET_CAMPAIGN_BLOCKLIST`

Return the blocklist masks configured for a campaign (contact list).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | Unique ID of the campaign (contact list). |
| `mask_filter` | string | No | Blocklist mask to search for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metric` | string ("origins" | "locations" | "list_size" | "subscriptions" | "removals" | "balance") | Yes | Statistic to retrieve: origins, locations, list_size, subscriptions, removals, or balance. |
| `group_by_filter` | string ("total" | "hour" | "day" | "month") | No | Time grouping for the statistics. |
| `campaign_id_filter` | string | Yes | Campaign ID whose selected statistic should be returned. |
| `created_on_to_filter` | string | No | Inclusive end date or date-time for the statistics interval. |
| `created_on_from_filter` | string | No | Inclusive start date or date-time for the statistics interval. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get campaign statistics summary

**Slug:** `GETRESPONSE_GET_CAMPAIGN_STATISTICS_SUMMARY`

Get subscriber, newsletter, trigger, landing-page, and webform totals by campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id_filter` | string | No | Optional campaign ID to limit the summary to one campaign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get cart by ID

**Slug:** `GETRESPONSE_GET_CART`

Get a cart and its selected variants by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `cart_id` | string | Yes | Cart ID. |
| `shop_id` | string | Yes | Shop ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single category by ID

**Slug:** `GETRESPONSE_GET_CATEGORY`

Get a category by shop ID and category ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | The shop ID. |
| `category_id` | string | Yes | The category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get click tracked link details

**Slug:** `GETRESPONSE_GET_CLICK_TRACK`

Get click tracked link details by click-track ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `click_track_id` | string | Yes | Click-track ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contact details by contact ID

**Slug:** `GETRESPONSE_GET_CONTACT`

Get contact details by contact ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `contact_id` | string | Yes | Unique contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a custom event by ID

**Slug:** `GETRESPONSE_GET_CUSTOM_EVENT`

Get a custom event definition by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `custom_event_id` | string | Yes | Custom event ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a custom field

**Slug:** `GETRESPONSE_GET_CUSTOM_FIELD`

Get a custom field definition by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the custom field ID is always returned. |
| `custom_field_id` | string | Yes | The custom field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `custom_report_id` | string | Yes | Custom report ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the ecommerce general performance statistics

**Slug:** `GETRESPONSE_GET_ECOMMERCE_PERFORMANCE`

Get aggregate ecommerce order and revenue performance statistics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `shop_id_filter` | string | No | Comma-separated shop IDs to include. |
| `order_date_to_filter` | string | No | Include orders through this YYYY-MM-DD date. |
| `order_date_from_filter` | string | No | Include orders from this YYYY-MM-DD date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the ecommerce revenue statistics

**Slug:** `GETRESPONSE_GET_ECOMMERCE_REVENUE_STATISTICS`

Get ecommerce revenue and order statistics over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `shop_id_filter` | string | No | Comma-separated shop IDs to include. |
| `order_date_to_filter` | string | No | Include orders through this YYYY-MM-DD date. |
| `order_date_from_filter` | string | No | Include orders from this YYYY-MM-DD date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get file by ID

**Slug:** `GETRESPONSE_GET_FILE`

Get File Library metadata and direct URLs for one file by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the file ID is always returned. |
| `file_id` | string | Yes | The file ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get storage space information

**Slug:** `GETRESPONSE_GET_FILE_LIBRARY_QUOTA`

Get the File Library storage limit and current usage in bytes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `form_id` | string | Yes | Form ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `popup_id` | string | Yes | Form or popup ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `popup_id` | string | Yes | Form or popup ID. |
| `device_filter` | string ("desktop" | "mobile") | No | Filter statistics by device type. |
| `date_to_filter` | string | No | End date for statistics in YYYY-MM-DD format. |
| `location_filter` | string | No | Filter statistics by location. |
| `date_from_filter` | string | No | Start date for statistics in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single 'From' address by ID

**Slug:** `GETRESPONSE_GET_FROM_ADDRESS`

Get a single GetResponse 'From' address by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `from_field_id` | string | Yes | The 'From' address ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GDPR field details

**Slug:** `GETRESPONSE_GET_GDPR_FIELD`

Get a GetResponse GDPR field and its latest consent-text version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `gdpr_field_id` | string | Yes | The GDPR field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get an import by ID

**Slug:** `GETRESPONSE_GET_IMPORT`

Get import details and processing statistics by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `import_id` | string | Yes | Import ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single landing page by ID

**Slug:** `GETRESPONSE_GET_LANDING_PAGE`

Get a current landing page by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `landing_page_id` | string | Yes | Landing page ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `page_filter` | string | No | Filter statistics by landing page UUID. |
| `device_filter` | string ("desktop" | "mobile") | No | Filter statistics by device type. |
| `date_to_filter` | string | No | End date or date-time for statistics. |
| `landing_page_id` | string | Yes | Landing page ID. |
| `location_filter` | string | No | Filter statistics by location. |
| `date_from_filter` | string | No | Start date or date-time for statistics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Legacy Form by ID

**Slug:** `GETRESPONSE_GET_LEGACY_FORM`

Get a legacy form by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `webform_id` | string | Yes | Legacy form ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get single landing page by ID

**Slug:** `GETRESPONSE_GET_LEGACY_LANDING_PAGE`

Get a legacy landing page by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `landing_page_id` | string | Yes | Legacy landing page ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the meta field by ID

**Slug:** `GETRESPONSE_GET_META_FIELD`

Get a meta field by shop ID and meta field ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | The shop ID. |
| `meta_field_id` | string | Yes | The meta field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single newsletter

**Slug:** `GETRESPONSE_GET_NEWSLETTER`

Get a single newsletter by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `newsletter_id` | string | Yes | Newsletter ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get newsletter statistics

**Slug:** `GETRESPONSE_GET_NEWSLETTER_STATISTICS`

Return one page of statistics for a newsletter and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum statistics rows to return (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `newsletter_id` | string | No | Newsletter ID; required on the first page. |
| `group_by_filter` | string ("total" | "hour" | "day" | "month") | No | Group results by time interval. |
| `created_on_to_filter` | string | No | Count data on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Count data on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get newsletter thumbnail

**Slug:** `GETRESPONSE_GET_NEWSLETTER_THUMBNAIL`

Download a newsletter thumbnail with its provider content type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string ("default" | "small") | No | Thumbnail size. |
| `newsletter_id` | string | Yes | Newsletter ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single order by ID

**Slug:** `GETRESPONSE_GET_ORDER`

Get one ecommerce order by its shop and order IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | The shop ID. |
| `order_id` | string | Yes | The order ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a predefined field by ID

**Slug:** `GETRESPONSE_GET_PREDEFINED_FIELD`

Get detailed information about one GetResponse predefined field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `predefined_field_id` | string | Yes | The predefined field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single product by ID

**Slug:** `GETRESPONSE_GET_PRODUCT`

Get a product and its nested ecommerce data by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | Shop ID. |
| `product_id` | string | Yes | Product ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | Shop ID. |
| `product_id` | string | Yes | Product ID. |
| `variant_id` | string | Yes | Variant ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get RSS newsletter by ID

**Slug:** `GETRESPONSE_GET_RSS_NEWSLETTER`

Get one RSS newsletter and its delivery configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `rss_newsletter_id` | string | Yes | RSS newsletter ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get RSS newsletter statistics by ID

**Slug:** `GETRESPONSE_GET_RSS_NEWSLETTER_STATISTICS`

Return one page of delivery statistics for one RSS newsletter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum statistics rows in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `group_by_filter` | string ("total" | "hour" | "day" | "month") | No | Time interval used to group statistics. |
| `rss_newsletter_id` | string | No | RSS newsletter ID; required on the first page. |
| `created_on_to_filter` | string | No | Count data on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Count data on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get search contacts by contact ID

**Slug:** `GETRESPONSE_GET_SAVED_CONTACT_SEARCH`

Get a saved contact search by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `saved_contact_search_id` | string | Yes | Saved contact search ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send limits

**Slug:** `GETRESPONSE_GET_SENDING_LIMITS`

Return the connected account's email sending allowances and usage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated sending-limit fields to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single shop by ID

**Slug:** `GETRESPONSE_GET_SHOP`

Get an ecommerce shop by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | The shop ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `sms_id` | string | Yes | Automated SMS message ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `sms_id` | string | Yes | SMS message ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `sms_id` | string | Yes | SMS message ID. |
| `created_on_to_filter` | string | No | End date for the statistics in ISO 8601 date format. |
| `created_on_from_filter` | string | No | Start date for the statistics in ISO 8601 date format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single subject A/B test

**Slug:** `GETRESPONSE_GET_SUBJECT_AB_TEST`

Get a single subject A/B test by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `ab_test_id` | string | Yes | A/B test ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a suppression list by ID

**Slug:** `GETRESPONSE_GET_SUPPRESSION`

Get a suppression list by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `suppression_id` | string | Yes | The suppression list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get tag by ID

**Slug:** `GETRESPONSE_GET_TAG`

Get a tag by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the tag ID is always returned. |
| `tag_id` | string | Yes | The tag ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single tax by ID

**Slug:** `GETRESPONSE_GET_TAX`

Get a tax by shop ID and tax ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `tax_id` | string | Yes | The tax ID. |
| `shop_id` | string | Yes | The shop ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get tracking JavaScript code snippets

**Slug:** `GETRESPONSE_GET_TRACKING`

Get the JavaScript snippets used to track purchases, abandoned carts, and visited URLs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `transactional_email_id` | string | Yes | Transactional email ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `tag_id_filter` | string | No | Filter by a specific tag ID. |
| `tagged_filter` | string ("true" | "false") | No | Filter by whether emails are tagged. |
| `group_by_filter` | string ("total" | "day") | Yes | Group statistics by total or day. |
| `time_frame_to_filter` | string | No | End of the statistics period as an ISO 8601 date or date-time. |
| `time_frame_from_filter` | string | No | Start of the statistics period as an ISO 8601 date or date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single template by ID

**Slug:** `GETRESPONSE_GET_TRANSACTIONAL_EMAIL_TEMPLATE`

Get a transactional email template by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `transactional_email_template_id` | string | Yes | Transactional email template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a webinar by ID

**Slug:** `GETRESPONSE_GET_WEBINAR`

Get a webinar by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `webinar_id` | string | Yes | Webinar ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single Website by ID

**Slug:** `GETRESPONSE_GET_WEBSITE`

Get a website by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `website_id` | string | Yes | Website ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `website_id` | string | Yes | Website ID. |
| `page_filter` | string | No | Filter statistics by website page UUID. |
| `device_filter` | string ("desktop" | "mobile") | No | Filter statistics by device type. |
| `date_to_filter` | string | No | End date or date-time for statistics. |
| `location_filter` | string | No | Filter statistics by location. |
| `date_from_filter` | string | No | Start date or date-time for statistics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a workflow by ID

**Slug:** `GETRESPONSE_GET_WORKFLOW`

Get a workflow and its subscriber statistics by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `workflow_id` | string | Yes | Workflow ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List A/B tests

**Slug:** `GETRESPONSE_LIST_AB_TESTS`

Return one page of A/B tests and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum tests to return (1-1000). |
| `name_filter` | string | No | Filter by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `type_filter` | string | No | Filter by A/B test type. |
| `status_filter` | string ("active" | "inactive") | No | Filter by status. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `created_on_to_filter` | string | No | Filter tests created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Filter tests created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### History of logins

**Slug:** `GETRESPONSE_LIST_ACCOUNT_LOGINS`

Return one page of account login history and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated login-history fields to return. |
| `page_size` | integer | No | Maximum login records to return in this page (1-1000). |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for page 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of addresses

**Slug:** `GETRESPONSE_LIST_ADDRESSES`

Return one filtered page of GetResponse addresses and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `page_size` | integer | No | Maximum addresses to return in this page (1-1000). |
| `zip_filter` | string | No | Filter by ZIP or postal code. |
| `city_filter` | string | No | Filter by city. |
| `name_filter` | string | No | Filter addresses by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for the first page. |
| `phone_filter` | string | No | Filter by phone number. |
| `company_filter` | string | No | Filter by company name. |
| `address1_filter` | string | No | Filter by first address line. |
| `address2_filter` | string | No | Filter by second address line. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation time in ascending or descending order. |
| `province_filter` | string | No | Filter by province or state name. |
| `last_name_filter` | string | No | Filter by last name. |
| `first_name_filter` | string | No | Filter by first name. |
| `created_on_to_filter` | string | No | Return addresses created on or before this ISO 8601 timestamp. |
| `province_code_filter` | string | No | Filter by province or state code. |
| `created_on_from_filter` | string | No | Return addresses created on or after this ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List autoresponders

**Slug:** `GETRESPONSE_LIST_AUTORESPONDERS`

Return one filtered page of autoresponders and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum autoresponders in this page (1-1000). |
| `name_filter` | string | No | Filter autoresponders by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `subject_sort` | string ("ASC" | "DESC") | No | Sort by subject. |
| `status_filter` | string ("enabled" | "disabled") | No | Filter autoresponders by status. |
| `delivered_sort` | string ("ASC" | "DESC") | No | Sort by delivered count. |
| `open_rate_sort` | string ("ASC" | "DESC") | No | Sort by open rate. |
| `subject_filter` | string | No | Filter autoresponders by subject. |
| `click_rate_sort` | string ("ASC" | "DESC") | No | Sort by click rate. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `day_of_cycle_sort` | string ("ASC" | "DESC") | No | Sort by autoresponder cycle day. |
| `campaign_id_filter` | string | No | Filter by campaign ID. |
| `created_on_to_filter` | string | No | Return autoresponders created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Return autoresponders created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum statistics rows in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `group_by_filter` | string ("total" | "hour" | "day" | "month") | No | Time interval used to group statistics. |
| `campaign_id_filter` | string | No | Comma-separated campaign IDs. Required unless autoresponder_id_filter is provided. |
| `created_on_to_filter` | string | No | Count data on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Count data on or after this ISO 8601 date or timestamp. |
| `autoresponder_id_filter` | string | No | Comma-separated autoresponder IDs. Required unless campaign_id_filter is provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Name sort direction. |
| `page_size` | integer | No | Maximum contacts in this page (1-1000). |
| `email_sort` | string ("ASC" | "DESC") | No | Email sort direction. |
| `campaign_id` | string | Yes | Campaign ID whose contacts to list. |
| `name_filter` | string | No | Filter contacts by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `email_filter` | string | No | Filter contacts by email. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Creation-date sort direction. |
| `created_on_to_filter` | string | No | Created on or before this ISO 8601 value. |
| `created_on_from_filter` | string | No | Created on or after this ISO 8601 value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List campaigns

**Slug:** `GETRESPONSE_LIST_CAMPAIGNS`

Return one page of GetResponse campaigns (contact lists), with filters and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the campaign ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort campaign names in ascending or descending order. |
| `page_size` | integer | No | Maximum campaigns to return in this page (1-1000). |
| `name_filter` | string | No | Return campaigns whose names match this filter. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort campaign creation dates in ascending or descending order. |
| `is_default_filter` | boolean | No | Filter campaigns by whether they are marked as default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get shop carts

**Slug:** `GETRESPONSE_LIST_CARTS`

Get one page of shop carts and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | Shop ID. |
| `page_size` | integer | No | Maximum carts in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `external_id_filter` | string | No | Filter by external cart ID. |
| `created_on_to_filter` | string | No | Filter carts created on or before this date or timestamp. |
| `created_on_from_filter` | string | No | Filter carts created on or after this date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the shop categories list

**Slug:** `GETRESPONSE_LIST_CATEGORIES`

Get one page of shop categories and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | The shop ID. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by category name. |
| `page_size` | integer | No | Maximum categories to return in this page (1-1000). |
| `name_filter` | string | No | Filter categories by name. |
| `next_cursor` | string | No | Page cursor from a previous call; omit for the first page. |
| `created_at_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `parent_id_filter` | string | No | Filter categories by parent ID. |
| `external_id_filter` | string | No | Filter categories by external ID. |
| `search_created_at_to` | string | No | Return categories created on or before this ISO 8601 timestamp. |
| `search_created_at_from` | string | No | Return categories created on or after this ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List click tracked links

**Slug:** `GETRESPONSE_LIST_CLICK_TRACKS`

Return one page of click tracked links and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum links to return (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by message creation date. |
| `created_on_to_filter` | string | No | Filter links from messages created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Filter links from messages created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of contact activities

**Slug:** `GETRESPONSE_LIST_CONTACT_ACTIVITIES`

Get one page of contact activities and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum activities to return in this page (1-1000). |
| `contact_id` | string | Yes | Unique contact ID. |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `created_on_to_filter` | string | No | Return activities created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Return activities created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contact's consent fields

**Slug:** `GETRESPONSE_LIST_CONTACT_CONSENTS`

Get the consent fields assigned to a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `contact_id` | string | Yes | Unique contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contact list

**Slug:** `GETRESPONSE_LIST_CONTACTS`

Get one page of contacts and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Name sort direction. |
| `page_size` | integer | No | Maximum contacts in this page (1-1000). |
| `email_sort` | string ("ASC" | "DESC") | No | Email sort direction. |
| `name_filter` | string | No | Filter contacts by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `email_filter` | string | No | 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") | No | Filter contacts by origin. |
| `changed_on_sort` | string ("ASC" | "DESC") | No | Change-date sort direction. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Creation-date sort direction. |
| `additional_flags` | string | No | Set to exactMatch to require exact email and name matches. |
| `campaign_id_sort` | string ("ASC" | "DESC") | No | Campaign-ID sort direction. |
| `campaign_id_filter` | string | No | Filter contacts by campaign ID. |
| `changed_on_to_filter` | string | No | Changed on or before this ISO 8601 value. |
| `created_on_to_filter` | string | No | Created on or before this ISO 8601 value. |
| `changed_on_from_filter` | string | No | Changed on or after this ISO 8601 value. |
| `created_on_from_filter` | string | No | Created on or after this ISO 8601 value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List custom events

**Slug:** `GETRESPONSE_LIST_CUSTOM_EVENTS`

Return one filtered page of custom event definitions and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort custom events by name. |
| `page_size` | integer | No | Maximum custom events in this page (1-1000). |
| `name_filter` | string | No | Filter custom events by name. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for page one. |
| `has_attributes_filter` | string ("true" | "false") | No | Filter by whether custom events define attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of custom fields

**Slug:** `GETRESPONSE_LIST_CUSTOM_FIELDS`

Get one page of custom field definitions and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; custom field ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by custom field name. |
| `page_size` | integer | No | Maximum custom fields to return (1-1000). |
| `name_filter` | string | No | Filter custom fields by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Name sort direction. |
| `page_size` | integer | No | Maximum reports in this page (1-1000). |
| `name_filter` | string | No | Filter custom reports by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `frequency_sort` | string ("ASC" | "DESC") | No | Frequency sort direction. |
| `generated_at_sort` | string ("ASC" | "DESC") | No | Generation-date sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the list of Facebook Pixels

**Slug:** `GETRESPONSE_LIST_FACEBOOK_PIXELS`

List Facebook Pixels assigned to the connected GetResponse account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the list of files

**Slug:** `GETRESPONSE_LIST_FILES`

Return one page of File Library files with filters and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by file name. |
| `page_size` | integer | No | Maximum files to return in this page (1-1000). |
| `size_sort` | string ("ASC" | "DESC") | No | Sort by file size. |
| `group_sort` | string ("ASC" | "DESC") | No | Sort by media group. |
| `name_filter` | string | No | Filter files by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `group_filter` | string ("audio" | "video" | "photo" | "document") | No | Filter files by media group. |
| `folder_id_filter` | string | No | Return files from this folder only. |
| `all_folders_filter` | string ("true" | "false") | No | Return files from all folders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the list of folders

**Slug:** `GETRESPONSE_LIST_FOLDERS`

Return one page of File Library folders with filters and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by folder name. |
| `page_size` | integer | No | Maximum folders to return in this page (1-1000). |
| `size_sort` | string ("ASC" | "DESC") | No | Sort by folder size. |
| `name_filter` | string | No | Filter folders by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by folder creation date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by form name. |
| `page_size` | integer | No | Maximum forms in this page (1-1000). |
| `name_filter` | string | No | Filter forms by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for page one. |
| `status_filter` | string ("enabled" | "disabled" | "published" | "unpublished" | "draft") | No | Filter forms by publication status. |
| `visitors_sort` | string ("ASC" | "DESC") | No | Sort by visitor count. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation time. |
| `subscribed_sort` | string ("ASC" | "DESC") | No | Sort by subscriber count. |
| `campaign_id_filter` | string | No | Filter by one or more comma-separated campaign IDs. |
| `created_on_to_filter` | string | No | Filter forms created on or before this date or date-time. |
| `unique_visitors_sort` | string ("ASC" | "DESC") | No | Sort by unique visitor count. |
| `created_on_from_filter` | string | No | Filter forms created on or after this date or date-time. |
| `subscription_rate_sort` | string ("ASC" | "DESC") | No | Sort by subscription rate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List forms and popups

**Slug:** `GETRESPONSE_LIST_FORMS_AND_POPUPS`

Return one filtered page of forms and popups and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `ctr_sort` | string ("ASC" | "DESC") | No | Sort by click-through rate. |
| `stats_to` | string | No | End date-time for embedded statistics. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum forms and popups in this page (1-1000). |
| `leads_sort` | string ("ASC" | "DESC") | No | Sort by lead count. |
| `stats_from` | string | No | Start date-time for embedded statistics. |
| `views_sort` | string ("ASC" | "DESC") | No | Sort by view count. |
| `name_filter` | string | No | Filter forms and popups by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for page one. |
| `status_sort` | string ("ASC" | "DESC") | No | Sort by status. |
| `status_filter` | string ("published" | "unpublished") | No | Filter forms and popups by status. |
| `created_at_sort` | string ("ASC" | "DESC") | No | Sort by creation time. |
| `updated_at_sort` | string ("ASC" | "DESC") | No | Sort by modification time. |
| `unique_visitors_sort` | string ("ASC" | "DESC") | No | Sort by unique visitor count. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `form_id` | string | Yes | Form ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `page_size` | integer | No | Maximum addresses to return in this page (1-1000). |
| `name_filter` | string | No | Filter by sender name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for the first page. |
| `email_filter` | string | No | Filter by sender email address. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation time in ascending or descending order. |
| `is_active_filter` | boolean | No | Filter to active or inactive addresses. |
| `is_default_filter` | boolean | No | Filter to default or non-default addresses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the GDPR fields list

**Slug:** `GETRESPONSE_LIST_GDPR_FIELDS`

Return one page of GetResponse GDPR fields and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by field name in ascending or descending order. |
| `page_size` | integer | No | Maximum GDPR fields to return in this page (1-1000). |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation time in ascending or descending order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get images list

**Slug:** `GETRESPONSE_LIST_IMAGES`

Return one page of GetResponse Multimedia images.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum images to return in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List imports

**Slug:** `GETRESPONSE_LIST_IMPORTS`

Return one filtered page of contact imports and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `page_size` | integer | No | Maximum imports in this page (1-1000). |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for page one. |
| `status_sort` | string ("ASC" | "DESC") | No | Sort by import status. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation time. |
| `finished_on_sort` | string ("ASC" | "DESC") | No | Sort by completion time. |
| `campaign_id_filter` | string | No | Filter imports by destination campaign ID. |
| `campaign_name_sort` | string ("ASC" | "DESC") | No | Sort by campaign name. |
| `added_contacts_sort` | string ("ASC" | "DESC") | No | Sort by added contact count. |
| `created_on_to_filter` | string | No | Return imports created on or before this ISO 8601 value. |
| `invalid_contacts_sort` | string ("ASC" | "DESC") | No | Sort by invalid contact count. |
| `updated_contacts_sort` | string ("ASC" | "DESC") | No | Sort by updated contact count. |
| `created_on_from_filter` | string | No | Return imports created on or after this ISO 8601 value. |
| `uploaded_contacts_sort` | string ("ASC" | "DESC") | No | Sort by uploaded contact count. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of Industry Tags

**Slug:** `GETRESPONSE_LIST_INDUSTRIES`

Return one page of industry tags and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated industry fields to return. |
| `page_size` | integer | No | Maximum industry tags to return in this page (1-1000). |
| `next_cursor` | string | No | Page-number continuation cursor returned by a previous call; omit for page 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `stats_to` | string | No | End date-time for embedded statistics. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum landing pages in this page (1-1000). |
| `leads_sort` | string ("ASC" | "DESC") | No | Sort by lead count. |
| `stats_from` | string | No | Start date-time for embedded statistics. |
| `name_filter` | string | No | Filter landing pages by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for page one. |
| `visits_sort` | string ("ASC" | "DESC") | No | Sort by visit count. |
| `status_filter` | string ("published" | "unpublished") | No | Filter landing pages by status. |
| `created_at_sort` | string ("ASC" | "DESC") | No | Sort by creation time. |
| `updated_at_sort` | string ("ASC" | "DESC") | No | Sort by modification time. |
| `subscription_rate_sort` | string ("ASC" | "DESC") | No | Sort by subscription rate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Legacy Forms

**Slug:** `GETRESPONSE_LIST_LEGACY_FORMS`

Return one filtered page of legacy forms and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `page_size` | integer | No | Maximum legacy forms in this page (1-1000). |
| `name_filter` | string | No | Filter legacy forms by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for page one. |
| `modified_on_sort` | string ("ASC" | "DESC") | No | Sort by modification time. |
| `campaign_id_filter` | string | No | Filter by one or more comma-separated campaign IDs. |
| `modified_on_to_filter` | string | No | Filter legacy forms modified on or before this date-time. |
| `modified_on_from_filter` | string | No | Filter legacy forms modified on or after this date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `page_size` | integer | No | Maximum landing pages in this page (1-1000). |
| `domain_sort` | string ("ASC" | "DESC") | No | Sort by domain. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for page one. |
| `domain_filter` | string | No | Filter by domain. |
| `status_filter` | string ("enabled" | "disabled") | No | Filter by status. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation time. |
| `meta_title_sort` | string ("ASC" | "DESC") | No | Sort by metadata title. |
| `campaign_id_sort` | string ("ASC" | "DESC") | No | Sort by campaign ID. |
| `subdomain_filter` | string | No | Filter by subdomain. |
| `meta_title_filter` | string | No | Filter by metadata title. |
| `campaign_id_filter` | string | No | Filter by one or more comma-separated encoded campaign IDs. |
| `user_domain_filter` | string | No | Filter by a user-provided domain. |
| `created_on_to_filter` | string | No | Filter pages created on or before this date or date-time. |
| `created_on_from_filter` | string | No | Filter pages created on or after this date or date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the shop meta fields

**Slug:** `GETRESPONSE_LIST_META_FIELDS`

Get one page of shop meta fields and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | The shop ID. |
| `page_size` | integer | No | Maximum meta fields to return in this page (1-1000). |
| `name_filter` | string | No | Filter meta fields by name. |
| `next_cursor` | string | No | Page cursor from a previous call; omit for the first page. |
| `value_filter` | string | No | Filter meta fields by value. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `description_filter` | string | No | Filter meta fields by description. |
| `created_on_to_filter` | string | No | Return meta fields created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Return meta fields created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List newsletters

**Slug:** `GETRESPONSE_LIST_NEWSLETTERS`

Return one page of newsletters and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum newsletters to return (1-1000). |
| `name_filter` | string | No | Filter by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `type_filter` | string ("draft" | "broadcast" | "splittest" | "automation") | No | Filter by newsletter type. |
| `send_on_sort` | string ("ASC" | "DESC") | No | Sort by send date. |
| `status_filter` | string ("enabled" | "disabled") | No | Filter by status. |
| `subject_filter` | string | No | Filter by subject. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `send_on_to_filter` | string | No | Filter newsletters sent on or before this date. |
| `campaign_id_filter` | string | No | Filter by campaign ID. |
| `send_on_from_filter` | string | No | Filter newsletters sent on or after this date. |
| `created_on_to_filter` | string | No | Filter newsletters created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Filter newsletters created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum statistics rows to return (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `group_by_filter` | string ("total" | "hour" | "day" | "month") | No | Group results by time interval. |
| `campaign_id_filter` | string | No | Filter by campaign IDs in the provider's accepted string format. Required unless newsletter_id_filter is provided. |
| `created_on_to_filter` | string | No | Count data on or before this ISO 8601 date or timestamp. |
| `newsletter_id_filter` | string | No | Filter by newsletter IDs in the provider's accepted string format. Required unless campaign_id_filter is provided. |
| `created_on_from_filter` | string | No | Count data on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the list of orders

**Slug:** `GETRESPONSE_LIST_ORDERS`

Get one page of orders and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | The shop ID. |
| `page_size` | integer | No | Maximum orders in this page (1-1000). |
| `next_cursor` | string | No | Page cursor from a previous call; omit for the first page. |
| `status_filter` | string | No | Filter orders by status. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort orders by creation date. |
| `description_filter` | string | No | Filter orders by description. |
| `external_id_filter` | string | No | Filter orders by external ID. |
| `processed_at_to_filter` | string | No | Include orders processed through this ISO 8601 time. |
| `processed_at_from_filter` | string | No | Include orders processed from this ISO 8601 time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the predefined fields list

**Slug:** `GETRESPONSE_LIST_PREDEFINED_FIELDS`

Return one filtered page of GetResponse predefined fields and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name in ascending or descending order. |
| `page_size` | integer | No | Maximum predefined fields to return in this page (1-1000). |
| `name_filter` | string | No | Filter by predefined field name. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `campaign_id_filter` | string | No | Filter by campaign ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a product list

**Slug:** `GETRESPONSE_LIST_PRODUCTS`

Get one page of products and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | Shop ID. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum products in this page (1-1000). |
| `name_filter` | string | No | Filter by product name. |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `vendor_filter` | string | No | Filter by vendor. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `category_id_filter` | string | No | Filter by category ID. |
| `external_id_filter` | string | No | Filter by external product ID. |
| `variant_name_filter` | string | No | Filter by variant name. |
| `category_name_filter` | string | No | Filter by category name. |
| `created_on_to_filter` | string | No | Filter products created on or before this date or timestamp. |
| `created_on_from_filter` | string | No | Filter products created on or after this date or timestamp. |
| `meta_field_names_filter` | string | No | Comma-separated meta field names. |
| `meta_field_values_filter` | string | No | Comma-separated meta field values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of product variants

**Slug:** `GETRESPONSE_LIST_PRODUCT_VARIANTS`

Get one page of product variants and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | Shop ID. |
| `page_size` | integer | No | Maximum variants in this page (1-1000). |
| `product_id` | string | Yes | Product ID. |
| `sku_filter` | string | No | Filter by stock-keeping unit. |
| `name_filter` | string | No | Filter by variant name. |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `description_filter` | string | No | Filter by description. |
| `external_id_filter` | string | No | Filter by external variant ID. |
| `created_at_to_filter` | string | No | Filter variants created on or before this timestamp. |
| `created_at_from_filter` | string | No | Filter variants created on or after this timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List RSS newsletters

**Slug:** `GETRESPONSE_LIST_RSS_NEWSLETTERS`

Return one filtered page of RSS newsletters and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `page_size` | integer | No | Maximum RSS newsletters in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `status_filter` | string ("enabled" | "disabled") | No | Filter RSS newsletters by status. |
| `subject_filter` | string | No | Filter RSS newsletters by subject. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `campaign_id_filter` | string | No | Filter by campaign ID. |
| `created_on_to_filter` | string | No | Return RSS newsletters created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Return RSS newsletters created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum statistics rows in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `group_by_filter` | string ("total" | "hour" | "day" | "month") | No | Time interval used to group statistics. |
| `campaign_id_filter` | string | No | Comma-separated campaign IDs. Required unless rss_newsletter_id_filter is provided. |
| `created_on_to_filter` | string | No | Count data on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Count data on or after this ISO 8601 date or timestamp. |
| `rss_newsletter_id_filter` | string | No | Comma-separated RSS newsletter IDs. Required unless campaign_id_filter is provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List saved contact searches

**Slug:** `GETRESPONSE_LIST_SAVED_CONTACT_SEARCHES`

Get one page of saved contact searches and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Name sort direction. |
| `page_size` | integer | No | Maximum saved searches in this page (1-1000). |
| `name_filter` | string | No | Filter saved searches by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Creation-date sort direction. |
| `created_on_to_filter` | string | No | Created on or before this ISO 8601 value. |
| `created_on_from_filter` | string | No | Created on or after this ISO 8601 value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contacts by search contacts ID

**Slug:** `GETRESPONSE_LIST_SAVED_SEARCH_CONTACTS`

Get one page of contacts matching a saved contact search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Name sort direction. |
| `page_size` | integer | No | Maximum contacts in this page (1-1000). |
| `email_sort` | string ("ASC" | "DESC") | No | Email sort direction. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Creation-date sort direction. |
| `saved_contact_search_id` | string | Yes | Saved contact search ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of shops

**Slug:** `GETRESPONSE_LIST_SHOPS`

Get one page of shops and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by shop name. |
| `page_size` | integer | No | Maximum shops to return in this page (1-1000). |
| `name_filter` | string | No | Filter shops by name. |
| `next_cursor` | string | No | Page cursor from a previous call; omit for the first page. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum messages in this page (1-1000). |
| `sent_sort` | string ("ASC" | "DESC") | No | Sort by sent-message count. |
| `clicks_sort` | string ("ASC" | "DESC") | No | Sort by link-click count. |
| `name_filter` | string | No | Filter automated SMS messages by name. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for page one. |
| `status_sort` | string ("ASC" | "DESC") | No | Sort by status. |
| `delivered_sort` | string ("ASC" | "DESC") | No | Sort by delivered-message count. |
| `has_links_filter` | boolean | No | Filter by whether the message contains links. |
| `modified_on_sort` | string ("ASC" | "DESC") | No | Sort by modification date. |
| `campaign_id_filter` | string | No | Filter by campaign ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum messages in this page (1-1000). |
| `sent_sort` | string ("ASC" | "DESC") | No | Sort by sent-message count. |
| `clicks_sort` | string ("ASC" | "DESC") | No | Sort by link-click count. |
| `name_filter` | string | No | Filter SMS messages by name. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for page one. |
| `type_filter` | string ("sms" | "draft") | No | Filter by SMS message type. |
| `send_on_sort` | string ("ASC" | "DESC") | No | Sort by sending date. |
| `delivered_sort` | string ("ASC" | "DESC") | No | Sort by delivered-message count. |
| `has_links_filter` | boolean | No | Filter by whether the message contains links. |
| `modified_on_sort` | string ("ASC" | "DESC") | No | Sort by modification date. |
| `campaign_id_filter` | string | No | Filter by campaign ID. |
| `sending_status_sort` | string ("ASC" | "DESC") | No | Sort by sending status. |
| `sending_status_filter` | string ("scheduled" | "sending" | "sent") | No | Filter by sending status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `status_filter` | string ("pending" | "active" | "rejected") | No | Filter sender names by status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum tests to return (1-1000). |
| `stage_sort` | string ("ASC" | "DESC") | No | Sort by stage. |
| `name_filter` | string | No | Filter by name. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `send_on_sort` | string ("ASC" | "DESC") | No | Sort by send date. |
| `stage_filter` | string ("preparing" | "testing" | "finished" | "sending-winner" | "cancelled" | "draft" | "completed") | No | Filter by stage. |
| `ab_test_id_filter` | string | No | Filter by one or more comma-separated A/B test IDs. |
| `campaign_id_filter` | string | No | Filter by one or more comma-separated campaign IDs. |
| `total_delivered_sort` | string ("ASC" | "DESC") | No | Sort by total delivered. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `language_code` | string | Yes | Language code for the confirmation templates, such as en. |
| `template_type` | string ("body" | "subject") | Yes | Template family to list: body or subject. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get suppression lists

**Slug:** `GETRESPONSE_LIST_SUPPRESSIONS`

Get one page of suppression lists and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; suppression ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by suppression list name. |
| `page_size` | integer | No | Maximum suppression lists to return (1-1000). |
| `name_filter` | string | No | Filter suppression lists by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for the first page. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation timestamp. |
| `created_on_to_filter` | string | No | Return suppression lists created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Return suppression lists created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the list of tags

**Slug:** `GETRESPONSE_LIST_TAGS`

Get one page of tags and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; tag ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by tag name. |
| `page_size` | integer | No | Maximum tags to return (1-1000). |
| `name_filter` | string | No | Filter tags by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for the first page. |
| `created_at_sort` | string ("ASC" | "DESC") | No | Sort by creation timestamp. |
| `created_at_to_filter` | string | No | Return tags created on or before this ISO 8601 date or timestamp. |
| `created_at_from_filter` | string | No | Return tags created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of taxes

**Slug:** `GETRESPONSE_LIST_TAXES`

Get one page of taxes for a shop and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `shop_id` | string | Yes | The shop ID. |
| `page_size` | integer | No | Maximum taxes to return in this page (1-1000). |
| `name_filter` | string | No | Filter taxes by name. |
| `next_cursor` | string | No | Page cursor from a previous call; omit for the first page. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort by creation date. |
| `created_on_to_filter` | string | No | Return taxes created on or before this ISO 8601 date or timestamp. |
| `created_on_from_filter` | string | No | Return taxes created on or after this ISO 8601 date or timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of timezones

**Slug:** `GETRESPONSE_LIST_TIMEZONES`

List timezones in the connected account's language context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated timezone fields to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum emails in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `tag_id_filter` | string | No | Filter by a specific tag ID. |
| `tagged_filter` | string ("true" | "false") | No | Filter by whether emails are tagged. |
| `sent_on_to_filter` | string | No | Filter emails sent on or before this ISO 8601 date or date-time. |
| `sent_on_from_filter` | string | No | Filter emails sent on or after this ISO 8601 date or date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `page_size` | integer | No | Maximum templates in this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `subject_sort` | string ("ASC" | "DESC") | No | Subject sort direction. |
| `subject_filter` | string | No | Filter templates by subject. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Creation-date sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List webinars

**Slug:** `GETRESPONSE_LIST_WEBINARS`

Return one filtered page of webinars and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort webinars by name. |
| `page_size` | integer | No | Maximum webinars in this page (1-1000). |
| `name_filter` | string | No | Filter webinars by name. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for page one. |
| `type_filter` | string ("all" | "live" | "on_demand") | No | Filter webinars by type. |
| `status_filter` | string ("upcoming" | "finished" | "published" | "unpublished") | No | Filter webinars by status. |
| `starts_on_sort` | string ("ASC" | "DESC") | No | Sort webinars by start time. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Sort webinars by creation time. |
| `campaign_id_filter` | string | No | Filter webinars by campaign ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the list of websites

**Slug:** `GETRESPONSE_LIST_WEBSITES`

Return one filtered page of websites and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `stats_to` | string | No | End date-time for embedded statistics. |
| `name_sort` | string ("ASC" | "DESC") | No | Sort by name. |
| `page_size` | integer | No | Maximum websites in this page (1-1000). |
| `stats_from` | string | No | Start date-time for embedded statistics. |
| `name_filter` | string | No | Filter websites by name. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for page one. |
| `visits_sort` | string ("ASC" | "DESC") | No | Sort by visit count. |
| `status_filter` | string ("published" | "unpublished") | No | Filter websites by status. |
| `created_at_sort` | string ("ASC" | "DESC") | No | Sort by creation time. |
| `page_views_sort` | string ("ASC" | "DESC") | No | Sort by page view count. |
| `updated_at_sort` | string ("ASC" | "DESC") | No | Sort by modification time. |
| `unique_visitors_sort` | string ("ASC" | "DESC") | No | Sort by unique visitor count. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List workflows

**Slug:** `GETRESPONSE_LIST_WORKFLOWS`

Return one page of workflows and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return; the ID is always returned. |
| `page_size` | integer | No | Maximum workflows in this page (1-1000). |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for page one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated fields to return. |
| `section` | array | Yes | Contact search sections. |
| `name_sort` | string ("ASC" | "DESC") | No | Name sort direction. |
| `page_size` | integer | No | Maximum contacts in this page (1-1000). |
| `email_sort` | string ("ASC" | "DESC") | No | Email sort direction. |
| `next_cursor` | string | No | Continuation cursor from a previous call. |
| `created_on_sort` | string ("ASC" | "DESC") | No | Creation-date sort direction. |
| `subscribers_type` | array | Yes | Subscription statuses included in the search. |
| `section_logic_operator` | string ("or" | "and") | Yes | Match any or all search sections. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ab_test_id` | string | Yes | A/B test ID. |
| `variant_id` | string | Yes | Message variant ID to select as the winner. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send newsletter draft

**Slug:** `GETRESPONSE_SEND_NEWSLETTER_DRAFT`

Send an existing newsletter draft using the supplied recipient and delivery settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | Newsletter draft ID. |
| `send_settings` | object | Yes | Recipient selection and delivery settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | SMS message name. |
| `content` | string | Yes | SMS message content. |
| `send_settings` | object | Yes | Sender and recipient settings for the selected recipients_type. |
| `recipients_type` | string ("contacts" | "importedNumbers") | Yes | Use contacts for GetResponse contacts or importedNumbers for manually supplied phone numbers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | object | No | Optional statistics tag. |
| `content` | object | No | Body for a direct-content email. |
| `subject` | string | No | Subject for a direct-content email. |
| `reply_to` | object | No | Reply-to address reference. |
| `template` | object | No | Stored template for a template email. |
| `from_field` | object | Yes | Sender address reference. |
| `recipients` | object | Yes | Message recipients; at most eight total recipients are supported. |
| `attachments` | array | No | Files attached to the email. |
| `content_type` | string ("direct" | "template") | No | Whether to send direct content or a stored template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set a 'From' address as default

**Slug:** `GETRESPONSE_SET_DEFAULT_FROM_ADDRESS`

Set an existing GetResponse 'From' address as the account default.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from_field_id` | string | Yes | The 'From' address ID to make the account default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of an existing custom event. |
| `attributes` | array | No | Values for attributes defined on the custom event. |
| `contact_id` | string | Yes | Contact ID for which to trigger the event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update account

**Slug:** `GETRESPONSE_UPDATE_ACCOUNT`

Update supplied profile fields on the connected GetResponse account. Provide at least one mutable field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City. |
| `phone` | string | No | Phone number. |
| `state` | string | No | State or region. |
| `street` | string | No | Street address. |
| `zip_code` | string | No | Postal code. |
| `last_name` | string | No | Last name. |
| `first_name` | string | No | First name. |
| `time_format` | string ("12h" | "24h") | No | Account time notation. |
| `company_name` | string | No | Company name. |
| `number_of_employees` | string ("50" | "250" | "500" | "more") | No | Company size bracket. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Turn on/off the GetResponse Badge

**Slug:** `GETRESPONSE_UPDATE_ACCOUNT_BADGE`

Enable or disable the selected GetResponse account badge type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("landing_page" | "website_builder_elegant" | "referral") | No | Account badge type. |
| `status` | string ("enabled" | "disabled") | Yes | Desired GetResponse badge status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `masks` | array | Yes | Blocklist masks to add, delete, or replace. |
| `additional_flags` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update address

**Slug:** `GETRESPONSE_UPDATE_ADDRESS`

Update only the supplied fields of an existing GetResponse address. Provide at least one mutable field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zip` | string | No | ZIP or postal code. |
| `city` | string | No | City. |
| `name` | string | No | Address label. |
| `phone` | string | No | Phone number. |
| `company` | string | No | Company name. |
| `address1` | string | No | First street-address line. |
| `address2` | string | No | Second street-address line. |
| `province` | string | No | Province or state name. |
| `last_name` | string | No | Recipient last name. |
| `address_id` | string | Yes | The address ID to update. |
| `first_name` | string | No | Recipient first name. |
| `country_code` | string | No | ISO 3166-1 alpha-3 country code. |
| `province_code` | string | No | Province or state code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Autoresponder name. |
| `flags` | array | No | Message tracking flags. |
| `status` | string ("enabled" | "disabled") | No | Autoresponder status. |
| `content` | object | No | Message content. |
| `subject` | string | No | Autoresponder message subject. |
| `reply_to` | object | No | Reply-to address. |
| `from_field` | object | No | Sender address. |
| `campaign_id` | string | No | Campaign ID. |
| `track_opens` | string ("true" | "false") | No | Whether to track message opens. |
| `send_settings` | object | No | Delivery settings. |
| `autoresponder_id` | string | Yes | Autoresponder ID to update. |
| `trigger_settings` | object | No | Autoresponder trigger conditions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Notification URL; required when enabling callbacks for the first time. |
| `actions` | object | No | Callback event types to enable or disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update campaign

**Slug:** `GETRESPONSE_UPDATE_CAMPAIGN`

Update a GetResponse campaign (contact list) and its confirmation or profile settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique campaign (contact list) name. |
| `postal` | object | No | Postal-address settings. |
| `profile` | object | No | Public campaign profile settings. |
| `is_default` | string ("true" | "false") | No | Whether this campaign is the account default. |
| `campaign_id` | string | Yes | Campaign ID to update. |
| `optin_types` | object | No | Opt-in settings by subscription source. |
| `confirmation` | object | No | Subscription confirmation settings. |
| `language_code` | string | No | ISO 639-1 campaign language code, also accepting zt, fs, and md. |
| `subscription_notifications` | object | No | Subscription notification settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update campaign blocklist

**Slug:** `GETRESPONSE_UPDATE_CAMPAIGN_BLOCKLIST`

Add, delete, or replace blocklist masks for a campaign (contact list).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `masks` | array | Yes | Blocklist masks to add, delete, or replace. |
| `campaign_id` | string | Yes | Unique ID of the campaign (contact list). |
| `additional_flags` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update cart

**Slug:** `GETRESPONSE_UPDATE_CART`

Update a cart and its selected variants. Provide at least one mutable field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cart_id` | string | Yes | Cart ID. |
| `shop_id` | string | Yes | Shop ID. |
| `cart_url` | string | No | External cart URL. |
| `currency` | string | No | ISO 4217 currency code. |
| `contact_id` | string | No | Contact ID that owns the cart. |
| `external_id` | string | No | External cart ID. |
| `total_price` | number | No | Total cart price excluding tax. |
| `total_tax_price` | number | No | Total cart price including tax. |
| `selected_variants` | array | No | Variants selected in the cart. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update category

**Slug:** `GETRESPONSE_UPDATE_CATEGORY`

Update a category's supplied fields. Provide at least one mutable field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | New external category URL. |
| `name` | string | No | New category name. |
| `shop_id` | string | Yes | The shop ID. |
| `parent_id` | string | No | New parent category ID. |
| `is_default` | boolean | No | Whether this is the default category. |
| `category_id` | string | Yes | The category ID. |
| `external_id` | string | No | New external category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New contact name. |
| `note` | string | No | Contact note; null removes it. |
| `tags` | array | No | Replacement set of contact tags. |
| `email` | string | No | New contact email address. |
| `scoring` | number | No | Contact score; null removes it. |
| `campaign` | object | No | Campaign to move the contact to. |
| `contact_id` | string | Yes | Unique contact ID. |
| `day_of_cycle` | string | No | Autoresponder cycle day; null removes the contact from the cycle. |
| `custom_field_values` | array | No | Replacement custom field values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a custom event

**Slug:** `GETRESPONSE_UPDATE_CUSTOM_EVENT`

Update a custom event definition and its attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique custom event name. |
| `attributes` | array | Yes | Complete collection of attributes for the custom event. |
| `custom_event_id` | string | Yes | Custom event ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a custom field

**Slug:** `GETRESPONSE_UPDATE_CUSTOM_FIELD`

Update a custom field definition's visibility and assigned values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hidden` | string ("true" | "false") | Yes | Whether the custom field is visible to contacts, as a provider string boolean. |
| `values` | array | Yes | Complete list of values assigned to the custom field. |
| `custom_field_id` | string | Yes | The custom field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update meta field

**Slug:** `GETRESPONSE_UPDATE_META_FIELD`

Update a meta field's supplied fields. Provide at least one mutable field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New meta field name. |
| `value` | string | No | New meta field value. |
| `shop_id` | string | Yes | The shop ID. |
| `value_type` | string ("string" | "integer") | No | New meta field value type. |
| `description` | string | No | New meta field description. |
| `meta_field_id` | string | Yes | The meta field ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string | No | New order status. |
| `cart_id` | string | No | New associated cart ID. |
| `shop_id` | string | Yes | The shop ID. |
| `currency` | string | No | New ISO 4217 currency code. |
| `order_id` | string | Yes | The order ID. |
| `order_url` | string | No | New external order URL. |
| `contact_id` | string | No | New contact ID for the order. |
| `description` | string | No | New order description. |
| `external_id` | string | No | New external order ID. |
| `meta_fields` | array | No | Complete replacement metadata collection for the order. |
| `total_price` | number | No | New total order price. |
| `processed_at` | string | No | New exact ISO 8601 time the order was made. |
| `billing_status` | string | No | New billing status. |
| `shipping_price` | number | No | New shipping price. |
| `billing_address` | object | No | Complete replacement billing address; individual fields cannot be patched. |
| `total_price_tax` | number | No | New total order tax. |
| `additional_flags` | string | No | Use `skipAutomation` to avoid triggering Make a purchase workflows. |
| `shipping_address` | object | No | Complete replacement shipping address; individual fields cannot be patched. |
| `selected_variants` | array | No | Complete replacement selected-variant collection for the order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a predefined field

**Slug:** `GETRESPONSE_UPDATE_PREDEFINED_FIELD`

Update the value of an existing GetResponse predefined field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | New predefined field value containing only ASCII letters and underscores. |
| `predefined_field_id` | string | Yes | The predefined field ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update product

**Slug:** `GETRESPONSE_UPDATE_PRODUCT`

Update a product and its nested ecommerce data. Provide at least one mutable field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | External product URL. |
| `name` | string | No | Product name. |
| `type` | string | No | Product type. |
| `vendor` | string | No | Product vendor. |
| `shop_id` | string | Yes | Shop ID. |
| `variants` | array | No | Product variants. |
| `categories` | array | No | Product categories. |
| `product_id` | string | Yes | Product ID. |
| `external_id` | string | No | External product ID. |
| `meta_fields` | array | No | Product meta fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | Unique stock-keeping unit. |
| `url` | string | No | External variant URL. |
| `name` | string | No | Variant name. |
| `price` | number | No | Price excluding tax. |
| `taxes` | array | No | Variant taxes. |
| `images` | array | No | Variant images. |
| `barcode` | string | No | Variant barcode. |
| `shop_id` | string | Yes | Shop ID. |
| `position` | integer | No | Variant position. |
| `quantity` | integer | No | Available quantity. |
| `price_tax` | number | No | Price including tax. |
| `product_id` | string | Yes | Product ID. |
| `variant_id` | string | Yes | Variant ID. |
| `description` | string | No | Variant description. |
| `external_id` | string | No | External variant ID. |
| `meta_fields` | array | No | Variant meta fields. |
| `previous_price` | number | No | Previous price excluding tax. |
| `previous_price_tax` | number | No | Previous price including tax. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Internal newsletter name. |
| `flags` | array | No | Message tracking flags. |
| `editor` | string ("custom" | "text" | "getresponse" | "legacy" | "html2") | No | Editor used to create the message. |
| `status` | string ("enabled" | "disabled") | No | RSS newsletter status. |
| `content` | object | No | Message content. |
| `subject` | string | No | RSS message subject. |
| `reply_to` | object | No | Reply-to address. |
| `from_field` | object | No | Sender address. |
| `rss_feed_url` | string | No | RSS feed URL. |
| `send_settings` | object | No | Delivery and audience settings. |
| `rss_newsletter_id` | string | Yes | RSS newsletter ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update search contacts

**Slug:** `GETRESPONSE_UPDATE_SAVED_CONTACT_SEARCH`

Replace a saved contact search's name and condition sections.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique saved-search name. |
| `section` | array | Yes | Replacement search sections. |
| `subscribers_type` | array | No | Subscription statuses included in the search. |
| `section_logic_operator` | string ("or" | "and") | Yes | Match any or all search sections. |
| `saved_contact_search_id` | string | Yes | Saved contact search ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update shop

**Slug:** `GETRESPONSE_UPDATE_SHOP`

Update a shop's supplied fields. Provide at least one mutable field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New shop name. |
| `locale` | string | No | New ISO 639-1 language locale. |
| `shop_id` | string | Yes | The shop ID. |
| `currency` | string | No | New ISO 4217 currency code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The new suppression list name. Omit to keep the current name. |
| `masks` | array | Yes | Complete list of masks to assign to the suppression list. |
| `suppression_id` | string | Yes | The suppression list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update tax

**Slug:** `GETRESPONSE_UPDATE_TAX`

Update a tax's supplied fields. Provide at least one mutable field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New tax name. |
| `rate` | number | No | New tax rate. |
| `tax_id` | string | Yes | The tax ID. |
| `shop_id` | string | Yes | The shop ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | object | No | New plain-text and/or HTML content. |
| `subject` | string | No | New template subject. |
| `transactional_email_template_id` | string | Yes | Transactional email template ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a workflow

**Slug:** `GETRESPONSE_UPDATE_WORKFLOW`

Set a workflow to active, inactive, or incomplete (draft).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("active" | "inactive" | "incomplete") | Yes | New workflow status; incomplete represents a draft. |
| `workflow_id` | string | Yes | Workflow ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload image

**Slug:** `GETRESPONSE_UPLOAD_IMAGE`

Upload an image file to GetResponse Multimedia.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Required image file. Provider semantics override the optional OpenAPI marker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique contact ID. |
| `custom_field_values` | array | Yes | Custom fields to add or update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to add without unassigning existing tags. |
| `contact_id` | string | Yes | Unique contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert product meta fields

**Slug:** `GETRESPONSE_UPSERT_META_FIELDS`

Assign meta fields to a product without removing existing assignments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | Shop ID. |
| `product_id` | string | Yes | Product ID. |
| `meta_fields` | array | Yes | Meta fields to assign without removing existing assignments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shop_id` | string | Yes | Shop ID. |
| `categories` | array | Yes | Categories to assign without removing existing assignments. |
| `product_id` | string | Yes | Product ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_values` | array | Yes | Custom fields to add or update on matching contacts. |
| `saved_contact_search_id` | string | Yes | Saved contact search ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |