Skip to main content
GetResponse logo
  • Category: marketing automation
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 213
  • Triggers: 0
  • Slug: GETRESPONSE
  • Version: 20261101_00

Tools

Slug: GETRESPONSE_CANCEL_AB_TESTSchedule cancellation of an A/B test.

Input Parameters

string
required
A/B test ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CANCEL_NEWSLETTER_SENDCancel newsletter sending and turn the newsletter into a draft.

Input Parameters

string
required
Newsletter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_ADDRESSCreate an address in the connected GetResponse account.

Input Parameters

string
ZIP or postal code.
string
City.
string
required
Address label.
string
Phone number.
string
Company name.
string
First street-address line.
string
Second street-address line.
string
Province or state name.
string
Recipient last name.
string
Recipient first name.
string
required
ISO 3166-1 alpha-3 country code.
string
Province or state code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_AND_SEND_NEWSLETTERCreate 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_AUTORESPONDERCreate an autoresponder with configured trigger and delivery timing. When enabled, it can automatically deliver its message when those conditions are met.

Input Parameters

string
Autoresponder name.
array
Message tracking flags.
string ("enabled" | "disabled")
required
Autoresponder status.
object
required
Message content.
string
required
Autoresponder message subject.
object
Reply-to address.
object
Sender address.
string
Campaign ID; omitted uses the default campaign.
string ("true" | "false")
Whether to track message opens.
object
required
Delivery settings.
object
required
Autoresponder trigger conditions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_CAMPAIGNCreate a campaign (contact list); configured double opt-in can automatically send confirmation emails, and subscription notifications can alert configured recipients.

Input Parameters

string
required
Unique campaign (contact list) name.
object
Postal-address settings.
object
Public campaign profile settings.
string ("true" | "false")
Whether this should be the default campaign.
object
Opt-in settings by subscription source.
object
Subscription confirmation settings.
string
ISO 639-1 campaign language code, also accepting zt, fs, and md.
object
Subscription notification settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_CARTCreate a cart with its selected product variants.

Input Parameters

string
required
Shop ID.
string
External cart URL.
string
required
ISO 4217 currency code.
string
required
Contact ID that owns the cart.
string
External cart ID.
number
required
Total cart price excluding tax.
number
Total cart price including tax.
array
required
Variants selected in the cart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_CATEGORYCreate a shop category; setting is_default makes it the shop’s default category and changes the previous default.

Input Parameters

string
External URL for the category.
string
required
The category name.
string
required
The shop ID.
string
The parent category ID.
boolean
Whether this is the default category.
string
Category ID assigned by another system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_CONTACTSubmit 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

string
Contact name.
array
Tags to assign to the contact.
string
required
Contact email address.
number
Contact score; null removes the score.
object
required
Campaign in which to create the contact.
string
Contact IPv4 or IPv6 address.
string
Autoresponder cycle day; null means not in the cycle.
array
Custom field values to assign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_CONTACTS_BATCHSubmit multiple contacts for asynchronous creation in one campaign. GetResponse returns no contact IDs; use LIST_CONTACTS after processing to find accepted contacts.

Input Parameters

array
required
Contacts to create (1-1000 contacts per batch).
string
required
Destination campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_CUSTOM_EVENTCreate a custom event definition with typed attributes.

Input Parameters

string
required
Unique custom event name.
array
required
Attributes defined for the custom event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_CUSTOM_FIELDCreate a custom field definition.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_CUSTOM_REPORTSchedule a one-time custom report. Requires a paid custom-reports entitlement, and available report types depend on the pricing plan.

Input Parameters

string
required
Custom report name.
string ("subscription_rejections" | "message_stats" | "unsubscribe_contacts_lists_report" | "standard_subscriber_activity_report" | "bounces" | "account_summary_report" | "user_activity" | "list_summary_report" | "isp_message_stats_report" | "webinar_participants_report" | "import_error_report" | "message_clicks_report" | "unconfirmed_contacts_stats_report" | "transactional_email_bounce_report" | "message_activity_report")
required
Custom report type; availability varies by pricing plan.
object
Required message activity filters; valid only for message_activity_report.
object
required
One-time reporting period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_FILECreate a File Library file from base64-encoded content.

Input Parameters

string
required
File name.
string
required
Folder in which to store the file, or null for the root-folder mode.
string
required
Base64-encoded file bytes, without a data URL prefix.
string
required
File extension without a leading dot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_FOLDERCreate a File Library folder.

Input Parameters

string
required
Folder name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_FROM_ADDRESSCreate a GetResponse sender name and email address.

Input Parameters

string
required
Name associated with the sender email address.
string
required
Email address to use as a sender.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_IMPORTStart an asynchronous contact import into a campaign.

Input Parameters

array
required
Contact rows whose values correspond positionally to field_mapping.
string
required
ID of the destination campaign (contact list).
array
required
Column mapping for each contact row. Include email and custom field names in row order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_META_FIELDCreate a meta field in a shop.

Input Parameters

string
required
The meta field name.
string
required
The meta field value.
string
required
The shop ID.
string ("string" | "integer")
required
The meta field value type.
string
The meta field description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_NEWSLETTER_DRAFTCreate a newsletter draft without sending or scheduling delivery. GetResponse requires send_settings but stores the message as a draft.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_ORDERCreate an ecommerce order and trigger matching Make a purchase workflows unless additional_flags is skipAutomation.

Input Parameters

string
Order status.
string
Associated cart ID.
string
required
The shop ID.
string
required
ISO 4217 order currency code.
string
External URL for the order.
string
required
ID of the contact placing the order.
string
Order description.
string
Order ID assigned by another system.
array
Order metadata fields.
number
required
Total order price.
string
Exact ISO 8601 time the order was made.
string
Order billing status.
number
Shipping price.
object
Complete billing address.
number
Total order tax.
string
Use skipAutomation to avoid triggering Make a purchase workflows.
object
Complete shipping address.
array
required
Selected product variants in the order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_PREDEFINED_FIELDCreate a campaign-specific predefined field in GetResponse.

Input Parameters

string
required
Predefined field name containing letters, numbers, and underscores.
string
required
Value substituted for the predefined field.
object
required
Campaign associated with the predefined field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_PRODUCTCreate a product and its nested ecommerce data in a shop.

Input Parameters

string
External product URL.
string
required
Product name.
string
Product type.
string
Product vendor.
string
required
Shop ID.
array
required
Product variants.
array
Product categories.
string
External product ID.
array
Product meta fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_PRODUCT_VARIANTCreate a product variant with images, meta fields, and taxes.

Input Parameters

string
required
Unique stock-keeping unit.
string
External variant URL.
string
required
Variant name.
number
required
Price excluding tax.
array
Variant taxes.
array
Variant images.
string
Variant barcode.
string
required
Shop ID.
integer
Variant position.
integer
Available quantity.
number
required
Price including tax.
string
required
Product ID.
string
Variant description.
string
External variant ID.
array
Variant meta fields.
number
Previous price excluding tax.
number
Previous price including tax.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_RSS_NEWSLETTERCreate and configure an RSS-to-email newsletter, which can deliver new feed content when enabled. Requires the RSS email-marketing entitlement.

Input Parameters

string
Internal newsletter name.
array
Message tracking flags.
string ("custom" | "text" | "getresponse" | "legacy" | "html2")
Editor used to create the message.
string ("enabled" | "disabled")
required
RSS newsletter status.
object
required
Message content.
string
required
RSS message subject.
object
Reply-to address.
object
required
Sender address.
string
required
RSS feed URL.
object
required
Delivery and audience settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_SAVED_CONTACT_SEARCHCreate a saved contact search from condition sections.

Input Parameters

string
required
Unique saved-search name.
array
required
Search sections to save.
array
Subscription statuses included in the search.
string ("or" | "and")
required
Match any or all search sections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_SHOPCreate an ecommerce shop.

Input Parameters

string
required
The shop name.
string
required
ISO 639-1 language locale.
string
required
ISO 4217 currency code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_SUBJECT_AB_TESTCreate a subject-line A/B test with two to five variants and start or schedule delivery to its selected recipients.

Input Parameters

string
required
A/B test name.
array
Tracking options enabled for the test.
object
required
Message content shared by the variants.
object
required
Campaign assigned to the A/B test.
object
Reply-to address.
array
required
Two to five subject variants, each no longer than 150 characters.
object
required
From address used by the variants.
object
required
Recipient selection settings.
object
required
A/B test delivery settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_SUPPRESSIONCreate a new suppression list.

Input Parameters

string
required
The suppression list name.
array
Masks to add to the suppression list, such as email addresses or domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_TAGAdd a new tag.

Input Parameters

string
required
Tag name containing only letters, digits, and underscores.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_TAXCreate a tax for a shop.

Input Parameters

string
required
The tax name.
number
required
The tax rate.
string
required
The shop ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_CREATE_TRANSACTIONAL_EMAIL_TEMPLATECreate a reusable transactional email template.

Input Parameters

object
Optional plain-text and/or HTML template content.
string
required
Template subject.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_AB_TESTDelete an A/B test.

Input Parameters

string
required
A/B test ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_ADDRESSDelete an existing GetResponse account address.

Input Parameters

string
required
The address ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_AUTORESPONDERPermanently delete an autoresponder.

Input Parameters

string
required
Autoresponder ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_CARTDelete a cart from a shop.

Input Parameters

string
required
Cart ID.
string
required
Shop ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_CATEGORYDelete a category from a shop.

Input Parameters

string
required
The shop ID.
string
required
The category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_CONTACTPermanently 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

string
required
Unique contact ID.
string
IPv4 address from which the contact unsubscribed; use with message_id.
string
Message ID used to simulate an unsubscribe from that message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_CUSTOM_EVENTDelete a custom event definition by ID.

Input Parameters

string
required
Custom event ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_CUSTOM_FIELDDelete a custom field definition by ID.

Input Parameters

string
required
The custom field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_FILEPermanently delete a File Library file by ID.

Input Parameters

string
required
The file ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_FOLDERPermanently delete a File Library folder by ID.

Input Parameters

string
required
The folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_FROM_ADDRESSDelete a GetResponse ‘From’ address, optionally replacing its references with another address.

Input Parameters

string
required
The ‘From’ address ID to delete.
string
Another ‘From’ address ID that should replace the deleted address where it is in use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_META_FIELDDelete a meta field from a shop.

Input Parameters

string
required
The shop ID.
string
required
The meta field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_NEWSLETTERDelete a newsletter by ID.

Input Parameters

string
required
Newsletter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_ORDERDelete an order from a shop.

Input Parameters

string
required
The shop ID.
string
required
The order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_PREDEFINED_FIELDDelete an existing GetResponse predefined field.

Input Parameters

string
required
The predefined field ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_PRODUCTDelete a product from a shop.

Input Parameters

string
required
Shop ID.
string
required
Product ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_PRODUCT_VARIANTDelete a product variant.

Input Parameters

string
required
Shop ID.
string
required
Product ID.
string
required
Variant ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_RSS_NEWSLETTERPermanently delete an RSS newsletter.

Input Parameters

string
required
RSS newsletter ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_SAVED_CONTACT_SEARCHDelete a saved contact search.

Input Parameters

string
required
Saved contact search ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_SHOPDelete an ecommerce shop.

Input Parameters

string
required
The shop ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_SUPPRESSIONDelete a suppression list by ID.

Input Parameters

string
required
The suppression list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_TAGDelete a tag by ID.

Input Parameters

string
required
The tag ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_TAXDelete a tax from a shop.

Input Parameters

string
required
The tax ID.
string
required
The shop ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DELETE_TRANSACTIONAL_EMAIL_TEMPLATEPermanently delete a transactional email template.

Input Parameters

string
required
Transactional email template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_DISABLE_CALLBACKSDisable all account-wide callbacks. Returns success=true for HTTP 204.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_AB_TESTGet a single A/B test by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
A/B test ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_ACCOUNTReturn information about the connected GetResponse account.

Input Parameters

string
Comma-separated fields to return; the account ID is always returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_ACCOUNT_BADGEReturn the current GetResponse badge status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_ACCOUNT_BILLINGReturn billing, plan, allowance, payment, and add-on information.

Input Parameters

string
Comma-separated billing fields to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_ACCOUNT_BLOCKLISTReturns account blocklist masks.

Input Parameters

string
Blocklist mask to search for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_ADDRESSGet one GetResponse account address by its ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The address ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_AUTORESPONDERGet one autoresponder and its delivery and trigger settings.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Autoresponder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_AUTORESPONDER_STATISTICSReturn one page of delivery statistics for one autoresponder.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_AUTORESPONDER_THUMBNAILDownload an autoresponder thumbnail image.

Input Parameters

string ("default" | "small")
Thumbnail size.
string
required
Autoresponder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CALLBACK_CONFIGURATIONGet the account-wide callback configuration, including its URL and enabled event types. If callbacks are not configured, the request returns an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CAMPAIGNGet a campaign (contact list) by its campaign ID.

Input Parameters

string
Comma-separated fields to return; the campaign ID is always returned.
string
required
Unique ID of the campaign (contact list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CAMPAIGN_BLOCKLISTReturn the blocklist masks configured for a campaign (contact list).

Input Parameters

string
required
Unique ID of the campaign (contact list).
string
Blocklist mask to search for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CAMPAIGN_STATISTICSGet one of six campaign metrics: subscriber origins, locations, list size, subscriptions, removals, or subscription-removal balance.

Input Parameters

string ("origins" | "locations" | "list_size" | "subscriptions" | "removals" | "balance")
required
Statistic to retrieve: origins, locations, list_size, subscriptions, removals, or balance.
string ("total" | "hour" | "day" | "month")
Time grouping for the statistics.
string
required
Campaign ID whose selected statistic should be returned.
string
Inclusive end date or date-time for the statistics interval.
string
Inclusive start date or date-time for the statistics interval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CAMPAIGN_STATISTICS_SUMMARYGet subscriber, newsletter, trigger, landing-page, and webform totals by campaign.

Input Parameters

string
Optional campaign ID to limit the summary to one campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CARTGet a cart and its selected variants by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Cart ID.
string
required
Shop ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CATEGORYGet a category by shop ID and category ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The shop ID.
string
required
The category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CONTACTGet contact details by contact ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Unique contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CUSTOM_EVENTGet a custom event definition by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Custom event ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CUSTOM_FIELDGet a custom field definition by ID.

Input Parameters

string
Comma-separated fields to return; the custom field ID is always returned.
string
required
The custom field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_CUSTOM_REPORTGet custom report status and generated files by ID. Requires a paid plan with custom reports.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Custom report ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_ECOMMERCE_PERFORMANCEGet aggregate ecommerce order and revenue performance statistics.

Input Parameters

string
Comma-separated fields to return.
string
Comma-separated shop IDs to include.
string
Include orders through this YYYY-MM-DD date.
string
Include orders from this YYYY-MM-DD date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_ECOMMERCE_REVENUE_STATISTICSGet ecommerce revenue and order statistics over time.

Input Parameters

string
Comma-separated fields to return.
string
Comma-separated shop IDs to include.
string
Include orders through this YYYY-MM-DD date.
string
Include orders from this YYYY-MM-DD date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_FILEGet File Library metadata and direct URLs for one file by ID.

Input Parameters

string
Comma-separated fields to return; the file ID is always returned.
string
required
The file ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_FILE_LIBRARY_QUOTAGet the File Library storage limit and current usage in bytes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_FORMGet 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

string
Comma-separated fields to return; the ID is always returned.
string
required
Form ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_FORM_OR_POPUPGet 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

string
Comma-separated fields to return; the ID is always returned.
string
required
Form or popup ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_FORM_OR_POPUP_PERFORMANCEGet performance statistics for an existing form or popup. Availability depends on the account plan.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Form or popup ID.
string ("desktop" | "mobile")
Filter statistics by device type.
string
End date for statistics in YYYY-MM-DD format.
string
Filter statistics by location.
string
Start date for statistics in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_FROM_ADDRESSGet a single GetResponse ‘From’ address by its ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The ‘From’ address ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_GDPR_FIELDGet a GetResponse GDPR field and its latest consent-text version.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The GDPR field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_IMPORTGet import details and processing statistics by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Import ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_LANDING_PAGEGet a current landing page by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Landing page ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_LANDING_PAGE_PERFORMANCEGet performance statistics for an existing landing page. Availability depends on the account plan.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
Filter statistics by landing page UUID.
string ("desktop" | "mobile")
Filter statistics by device type.
string
End date or date-time for statistics.
string
required
Landing page ID.
string
Filter statistics by location.
string
Start date or date-time for statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_LEGACY_FORMGet a legacy form by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Legacy form ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_LEGACY_LANDING_PAGEGet a legacy landing page by ID. The response is an array of landing page details.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Legacy landing page ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_META_FIELDGet a meta field by shop ID and meta field ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The shop ID.
string
required
The meta field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_NEWSLETTERGet a single newsletter by its ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Newsletter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_NEWSLETTER_STATISTICSReturn one page of statistics for a newsletter and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_NEWSLETTER_THUMBNAILDownload a newsletter thumbnail with its provider content type.

Input Parameters

string ("default" | "small")
Thumbnail size.
string
required
Newsletter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_ORDERGet one ecommerce order by its shop and order IDs.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The shop ID.
string
required
The order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_PREDEFINED_FIELDGet detailed information about one GetResponse predefined field.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The predefined field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_PRODUCTGet a product and its nested ecommerce data by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Shop ID.
string
required
Product ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_PRODUCT_VARIANTGet a product variant and its nested ecommerce data by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Shop ID.
string
required
Product ID.
string
required
Variant ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_RSS_NEWSLETTERGet one RSS newsletter and its delivery configuration.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
RSS newsletter ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_RSS_NEWSLETTER_STATISTICSReturn one page of delivery statistics for one RSS newsletter.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_SAVED_CONTACT_SEARCHGet a saved contact search by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Saved contact search ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_SENDING_LIMITSReturn the connected account’s email sending allowances and usage.

Input Parameters

string
Comma-separated sending-limit fields to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_SHOPGet an ecommerce shop by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The shop ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_SMS_AUTOMATION_MESSAGEGet an automated SMS message. Requires a paid SMS plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Automated SMS message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_SMS_MESSAGEGet an SMS message. Requires a paid SMS plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
SMS message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_SMS_STATISTICSGet SMS message statistics. Requires a paid SMS plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
SMS message ID.
string
End date for the statistics in ISO 8601 date format.
string
Start date for the statistics in ISO 8601 date format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_SUBJECT_AB_TESTGet a single subject A/B test by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
A/B test ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_SUPPRESSIONGet a suppression list by ID.

Input Parameters

string
required
The suppression list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_TAGGet a tag by ID.

Input Parameters

string
Comma-separated fields to return; the tag ID is always returned.
string
required
The tag ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_TAXGet a tax by shop ID and tax ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The tax ID.
string
required
The shop ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_TRACKINGGet the JavaScript snippets used to track purchases, abandoned carts, and visited URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_TRANSACTIONAL_EMAILGet transactional email details by ID. Requires a paid transactional-email plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Transactional email ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_TRANSACTIONAL_EMAIL_STATISTICSGet aggregate transactional email statistics. Requires a paid transactional-email plan or add-on.

Input Parameters

string
Comma-separated fields to return.
string
Filter by a specific tag ID.
string ("true" | "false")
Filter by whether emails are tagged.
string ("total" | "day")
required
Group statistics by total or day.
string
End of the statistics period as an ISO 8601 date or date-time.
string
Start of the statistics period as an ISO 8601 date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_TRANSACTIONAL_EMAIL_TEMPLATEGet a transactional email template by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Transactional email template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_WEBINARGet a webinar by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Webinar ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_WEBSITEGet a website by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Website ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_WEBSITE_PERFORMANCEGet performance statistics for an existing website. Availability depends on the account plan.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Website ID.
string
Filter statistics by website page UUID.
string ("desktop" | "mobile")
Filter statistics by device type.
string
End date or date-time for statistics.
string
Filter statistics by location.
string
Start date or date-time for statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_GET_WORKFLOWGet a workflow and its subscriber statistics by ID.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Workflow ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_AB_TESTSReturn one page of A/B tests and a continuation cursor. Results are filtered to active tests by default; the status filter can select inactive tests.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum tests to return (1-1000).
string
Filter by name.
string
Continuation cursor from a previous call.
string
Filter by A/B test type.
string ("active" | "inactive")
Filter by status.
string ("ASC" | "DESC")
Sort by creation date.
string
Filter tests created on or before this ISO 8601 date or timestamp.
string
Filter tests created on or after this ISO 8601 date or timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_ACCOUNT_LOGINSReturn one page of account login history and a continuation cursor.

Input Parameters

string
Comma-separated login-history fields to return.
integer
Maximum login records to return in this page (1-1000).
string
Opaque continuation cursor returned by a previous call; omit for page 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_ADDRESSESReturn one filtered page of GetResponse addresses and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
integer
Maximum addresses to return in this page (1-1000).
string
Filter by ZIP or postal code.
string
Filter by city.
string
Filter addresses by name.
string
Opaque continuation cursor from a previous call; omit for the first page.
string
Filter by phone number.
string
Filter by company name.
string
Filter by first address line.
string
Filter by second address line.
string ("ASC" | "DESC")
Sort by creation time in ascending or descending order.
string
Filter by province or state name.
string
Filter by last name.
string
Filter by first name.
string
Return addresses created on or before this ISO 8601 timestamp.
string
Filter by province or state code.
string
Return addresses created on or after this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_AUTORESPONDERSReturn one filtered page of autoresponders and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum autoresponders in this page (1-1000).
string
Filter autoresponders by name.
string
Continuation cursor from a previous call; omit for the first page.
string ("ASC" | "DESC")
Sort by subject.
string ("enabled" | "disabled")
Filter autoresponders by status.
string ("ASC" | "DESC")
Sort by delivered count.
string ("ASC" | "DESC")
Sort by open rate.
string
Filter autoresponders by subject.
string ("ASC" | "DESC")
Sort by click rate.
string ("ASC" | "DESC")
Sort by creation date.
string ("ASC" | "DESC")
Sort by autoresponder cycle day.
string
Filter by campaign ID.
string
Return autoresponders created on or before this ISO 8601 date or timestamp.
string
Return autoresponders created on or after this ISO 8601 date or timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_AUTORESPONDER_STATISTICSReturn one filtered page of statistics across autoresponders. Provide an autoresponder or campaign ID filter.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CAMPAIGN_CONTACTSList the contacts directly related to one campaign using the campaign-membership endpoint, with relationship-specific filters and a continuation cursor.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Name sort direction.
integer
Maximum contacts in this page (1-1000).
string ("ASC" | "DESC")
Email sort direction.
string
required
Campaign ID whose contacts to list.
string
Filter contacts by name.
string
Continuation cursor from a previous call.
string
Filter contacts by email.
string ("ASC" | "DESC")
Creation-date sort direction.
string
Created on or before this ISO 8601 value.
string
Created on or after this ISO 8601 value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CAMPAIGNSReturn one page of GetResponse campaigns (contact lists), with filters and sorting.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CARTSGet one page of shop carts and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Shop ID.
integer
Maximum carts in this page (1-1000).
string
Continuation cursor from a previous call; omit for the first page.
string ("ASC" | "DESC")
Sort by creation date.
string
Filter by external cart ID.
string
Filter carts created on or before this date or timestamp.
string
Filter carts created on or after this date or timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CATEGORIESGet one page of shop categories and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The shop ID.
string ("ASC" | "DESC")
Sort by category name.
integer
Maximum categories to return in this page (1-1000).
string
Filter categories by name.
string
Page cursor from a previous call; omit for the first page.
string ("ASC" | "DESC")
Sort by creation date.
string
Filter categories by parent ID.
string
Filter categories by external ID.
string
Return categories created on or before this ISO 8601 timestamp.
string
Return categories created on or after this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CONTACT_ACTIVITIESGet one page of contact activities and a continuation cursor.

Input Parameters

string
Comma-separated fields to return.
integer
Maximum activities to return in this page (1-1000).
string
required
Unique contact ID.
string
Continuation cursor from a previous call; omit for the first page.
string
Return activities created on or before this ISO 8601 date or timestamp.
string
Return activities created on or after this ISO 8601 date or timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CONTACTSGet one page of contacts and a continuation cursor.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Name sort direction.
integer
Maximum contacts in this page (1-1000).
string ("ASC" | "DESC")
Email sort direction.
string
Filter contacts by name.
string
Continuation cursor from a previous call.
string
Filter contacts by email.
string ("import" | "email" | "www" | "panel" | "leads" | "sale" | "api" | "survey" | "iphone" | "copy" | "landing_page" | "webinar" | "website_builder_elegant" | "chat" | "course" | "premium_newsletter")
Filter contacts by origin.
string ("ASC" | "DESC")
Change-date sort direction.
string ("ASC" | "DESC")
Creation-date sort direction.
string
Set to exactMatch to require exact email and name matches.
string ("ASC" | "DESC")
Campaign-ID sort direction.
string
Filter contacts by campaign ID.
string
Changed on or before this ISO 8601 value.
string
Created on or before this ISO 8601 value.
string
Changed on or after this ISO 8601 value.
string
Created on or after this ISO 8601 value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CUSTOM_EVENTSReturn one filtered page of custom event definitions and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CUSTOM_FIELDSGet one page of custom field definitions and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_CUSTOM_REPORTSGet one page of custom reports. Requires a paid plan with the custom-reports entitlement.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Name sort direction.
integer
Maximum reports in this page (1-1000).
string
Filter custom reports by name.
string
Continuation cursor from a previous call.
string ("ASC" | "DESC")
Frequency sort direction.
string ("ASC" | "DESC")
Generation-date sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_FACEBOOK_PIXELSList Facebook Pixels assigned to the connected GetResponse account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_FILESReturn one page of File Library files with filters and sorting.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Sort by file name.
integer
Maximum files to return in this page (1-1000).
string ("ASC" | "DESC")
Sort by file size.
string ("ASC" | "DESC")
Sort by media group.
string
Filter files by name.
string
Continuation cursor from a previous call.
string ("audio" | "video" | "photo" | "document")
Filter files by media group.
string
Return files from this folder only.
string ("true" | "false")
Return files from all folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_FOLDERSReturn one page of File Library folders with filters and sorting.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Sort by folder name.
integer
Maximum folders to return in this page (1-1000).
string ("ASC" | "DESC")
Sort by folder size.
string
Filter folders by name.
string
Continuation cursor from a previous call.
string ("ASC" | "DESC")
Sort by folder creation date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_FORMSReturn one filtered page of modern forms and a continuation cursor. This endpoint requires the relevant paid GetResponse plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string ("ASC" | "DESC")
Sort by form name.
integer
Maximum forms in this page (1-1000).
string
Filter forms by name.
string
Opaque continuation cursor from a previous call; omit for page one.
string ("enabled" | "disabled" | "published" | "unpublished" | "draft")
Filter forms by publication status.
string ("ASC" | "DESC")
Sort by visitor count.
string ("ASC" | "DESC")
Sort by creation time.
string ("ASC" | "DESC")
Sort by subscriber count.
string
Filter by one or more comma-separated campaign IDs.
string
Filter forms created on or before this date or date-time.
string ("ASC" | "DESC")
Sort by unique visitor count.
string
Filter forms created on or after this date or date-time.
string ("ASC" | "DESC")
Sort by subscription rate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_FORMS_AND_POPUPSReturn one filtered page of forms and popups and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string ("ASC" | "DESC")
Sort by click-through rate.
string
End date-time for embedded statistics.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum forms and popups in this page (1-1000).
string ("ASC" | "DESC")
Sort by lead count.
string
Start date-time for embedded statistics.
string ("ASC" | "DESC")
Sort by view count.
string
Filter forms and popups by name.
string
Opaque continuation cursor from a previous call; omit for page one.
string ("ASC" | "DESC")
Sort by status.
string ("published" | "unpublished")
Filter forms and popups by status.
string ("ASC" | "DESC")
Sort by creation time.
string ("ASC" | "DESC")
Sort by modification time.
string ("ASC" | "DESC")
Sort by unique visitor count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_FORM_VARIANTSGet all A/B test variants for a modern form. This endpoint requires the relevant paid GetResponse plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Form ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_FROM_ADDRESSESReturn one filtered page of GetResponse ‘From’ addresses and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_GDPR_FIELDSReturn one page of GetResponse GDPR fields and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_IMAGESReturn one page of GetResponse Multimedia images.

Input Parameters

string
Comma-separated fields to return.
integer
Maximum images to return in this page (1-1000).
string
Continuation cursor from a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_IMPORTSReturn one filtered page of contact imports and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
integer
Maximum imports in this page (1-1000).
string
Opaque continuation cursor returned by a previous call; omit for page one.
string ("ASC" | "DESC")
Sort by import status.
string ("ASC" | "DESC")
Sort by creation time.
string ("ASC" | "DESC")
Sort by completion time.
string
Filter imports by destination campaign ID.
string ("ASC" | "DESC")
Sort by campaign name.
string ("ASC" | "DESC")
Sort by added contact count.
string
Return imports created on or before this ISO 8601 value.
string ("ASC" | "DESC")
Sort by invalid contact count.
string ("ASC" | "DESC")
Sort by updated contact count.
string
Return imports created on or after this ISO 8601 value.
string ("ASC" | "DESC")
Sort by uploaded contact count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_INDUSTRIESReturn one page of industry tags and a continuation cursor.

Input Parameters

string
Comma-separated industry fields to return.
integer
Maximum industry tags to return in this page (1-1000).
string
Page-number continuation cursor returned by a previous call; omit for page 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_LANDING_PAGESReturn one filtered page of current landing pages and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
End date-time for embedded statistics.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum landing pages in this page (1-1000).
string ("ASC" | "DESC")
Sort by lead count.
string
Start date-time for embedded statistics.
string
Filter landing pages by name.
string
Opaque continuation cursor from a previous call; omit for page one.
string ("ASC" | "DESC")
Sort by visit count.
string ("published" | "unpublished")
Filter landing pages by status.
string ("ASC" | "DESC")
Sort by creation time.
string ("ASC" | "DESC")
Sort by modification time.
string ("ASC" | "DESC")
Sort by subscription rate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_LEGACY_FORMSReturn one filtered page of legacy forms and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_LEGACY_LANDING_PAGESReturn one filtered page of legacy landing pages and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
integer
Maximum landing pages in this page (1-1000).
string ("ASC" | "DESC")
Sort by domain.
string
Opaque continuation cursor from a previous call; omit for page one.
string
Filter by domain.
string ("enabled" | "disabled")
Filter by status.
string ("ASC" | "DESC")
Sort by creation time.
string ("ASC" | "DESC")
Sort by metadata title.
string ("ASC" | "DESC")
Sort by campaign ID.
string
Filter by subdomain.
string
Filter by metadata title.
string
Filter by one or more comma-separated encoded campaign IDs.
string
Filter by a user-provided domain.
string
Filter pages created on or before this date or date-time.
string
Filter pages created on or after this date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_META_FIELDSGet one page of shop meta fields and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The shop ID.
integer
Maximum meta fields to return in this page (1-1000).
string
Filter meta fields by name.
string
Page cursor from a previous call; omit for the first page.
string
Filter meta fields by value.
string ("ASC" | "DESC")
Sort by creation date.
string
Filter meta fields by description.
string
Return meta fields created on or before this ISO 8601 date or timestamp.
string
Return meta fields created on or after this ISO 8601 date or timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_NEWSLETTERSReturn one page of newsletters and a continuation cursor.

Input Parameters

string
Comma-separated fields to return.
integer
Maximum newsletters to return (1-1000).
string
Filter by name.
string
Continuation cursor from a previous call.
string ("draft" | "broadcast" | "splittest" | "automation")
Filter by newsletter type.
string ("ASC" | "DESC")
Sort by send date.
string ("enabled" | "disabled")
Filter by status.
string
Filter by subject.
string ("ASC" | "DESC")
Sort by creation date.
string
Filter newsletters sent on or before this date.
string
Filter by campaign ID.
string
Filter newsletters sent on or after this date.
string
Filter newsletters created on or before this ISO 8601 date or timestamp.
string
Filter newsletters created on or after this ISO 8601 date or timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_NEWSLETTER_STATISTICSReturn one page of total newsletter statistics and a continuation cursor. Provide a newsletter or campaign ID filter.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_ORDERSGet one page of orders and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The shop ID.
integer
Maximum orders in this page (1-1000).
string
Page cursor from a previous call; omit for the first page.
string
Filter orders by status.
string ("ASC" | "DESC")
Sort orders by creation date.
string
Filter orders by description.
string
Filter orders by external ID.
string
Include orders processed through this ISO 8601 time.
string
Include orders processed from this ISO 8601 time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_PREDEFINED_FIELDSReturn one filtered page of GetResponse predefined fields and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_PRODUCTSGet one page of products and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Shop ID.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum products in this page (1-1000).
string
Filter by product name.
string
Continuation cursor from a previous call; omit for the first page.
string
Filter by vendor.
string ("ASC" | "DESC")
Sort by creation date.
string
Filter by category ID.
string
Filter by external product ID.
string
Filter by variant name.
string
Filter by category name.
string
Filter products created on or before this date or timestamp.
string
Filter products created on or after this date or timestamp.
string
Comma-separated meta field names.
string
Comma-separated meta field values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_PRODUCT_VARIANTSGet one page of product variants and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Shop ID.
integer
Maximum variants in this page (1-1000).
string
required
Product ID.
string
Filter by stock-keeping unit.
string
Filter by variant name.
string
Continuation cursor from a previous call; omit for the first page.
string ("ASC" | "DESC")
Sort by creation date.
string
Filter by description.
string
Filter by external variant ID.
string
Filter variants created on or before this timestamp.
string
Filter variants created on or after this timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_RSS_NEWSLETTERSReturn one filtered page of RSS newsletters and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_RSS_NEWSLETTER_STATISTICSReturn one filtered page of statistics across RSS newsletters. Provide an RSS newsletter or campaign ID filter.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SAVED_CONTACT_SEARCHESGet one page of saved contact searches and a continuation cursor.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Name sort direction.
integer
Maximum saved searches in this page (1-1000).
string
Filter saved searches by name.
string
Continuation cursor from a previous call.
string ("ASC" | "DESC")
Creation-date sort direction.
string
Created on or before this ISO 8601 value.
string
Created on or after this ISO 8601 value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SAVED_SEARCH_CONTACTSGet one page of contacts matching a saved contact search.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Name sort direction.
integer
Maximum contacts in this page (1-1000).
string ("ASC" | "DESC")
Email sort direction.
string
Continuation cursor from a previous call.
string ("ASC" | "DESC")
Creation-date sort direction.
string
required
Saved contact search ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SHOPSGet one page of shops and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SMS_AUTOMATION_MESSAGESReturn one page of automated SMS messages. Requires a paid SMS plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum messages in this page (1-1000).
string ("ASC" | "DESC")
Sort by sent-message count.
string ("ASC" | "DESC")
Sort by link-click count.
string
Filter automated SMS messages by name.
string
Continuation cursor returned by a previous call; omit for page one.
string ("ASC" | "DESC")
Sort by status.
string ("ASC" | "DESC")
Sort by delivered-message count.
Filter by whether the message contains links.
string ("ASC" | "DESC")
Sort by modification date.
string
Filter by campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SMS_MESSAGESReturn one page of SMS messages. Requires a paid SMS plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum messages in this page (1-1000).
string ("ASC" | "DESC")
Sort by sent-message count.
string ("ASC" | "DESC")
Sort by link-click count.
string
Filter SMS messages by name.
string
Continuation cursor returned by a previous call; omit for page one.
string ("sms" | "draft")
Filter by SMS message type.
string ("ASC" | "DESC")
Sort by sending date.
string ("ASC" | "DESC")
Sort by delivered-message count.
Filter by whether the message contains links.
string ("ASC" | "DESC")
Sort by modification date.
string
Filter by campaign ID.
string ("ASC" | "DESC")
Sort by sending status.
string ("scheduled" | "sending" | "sent")
Filter by sending status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SMS_SENDER_NAMESGet SMS sender names. Requires a paid SMS plan or add-on.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string ("pending" | "active" | "rejected")
Filter sender names by status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SUBJECT_AB_TESTSReturn one page of subject A/B tests and a continuation cursor.

Input Parameters

string
Comma-separated fields to return.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum tests to return (1-1000).
string ("ASC" | "DESC")
Sort by stage.
string
Filter by name.
string
Continuation cursor from a previous call.
string ("ASC" | "DESC")
Sort by send date.
string ("preparing" | "testing" | "finished" | "sending-winner" | "cancelled" | "draft" | "completed")
Filter by stage.
string
Filter by one or more comma-separated A/B test IDs.
string
Filter by one or more comma-separated campaign IDs.
string ("ASC" | "DESC")
Sort by total delivered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SUBSCRIPTION_CONFIRMATION_TEMPLATESList unpaginated body or subject templates for subscription-confirmation emails in one language.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
Language code for the confirmation templates, such as en.
string ("body" | "subject")
required
Template family to list: body or subject.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_SUPPRESSIONSGet one page of suppression lists and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_TAGSGet one page of tags and a continuation cursor.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_TAXESGet one page of taxes for a shop and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
required
The shop ID.
integer
Maximum taxes to return in this page (1-1000).
string
Filter taxes by name.
string
Page cursor from a previous call; omit for the first page.
string ("ASC" | "DESC")
Sort by creation date.
string
Return taxes created on or before this ISO 8601 date or timestamp.
string
Return taxes created on or after this ISO 8601 date or timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_TIMEZONESList timezones in the connected account’s language context.

Input Parameters

string
Comma-separated timezone fields to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_TRANSACTIONAL_EMAILSGet one page of transactional email history. Requires a paid transactional-email plan or add-on.

Input Parameters

string
Comma-separated fields to return.
integer
Maximum emails in this page (1-1000).
string
Continuation cursor from a previous call.
string
Filter by a specific tag ID.
string ("true" | "false")
Filter by whether emails are tagged.
string
Filter emails sent on or before this ISO 8601 date or date-time.
string
Filter emails sent on or after this ISO 8601 date or date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_TRANSACTIONAL_EMAIL_TEMPLATESGet one page of transactional email templates and a continuation cursor.

Input Parameters

string
Comma-separated fields to return.
integer
Maximum templates in this page (1-1000).
string
Continuation cursor from a previous call.
string ("ASC" | "DESC")
Subject sort direction.
string
Filter templates by subject.
string ("ASC" | "DESC")
Creation-date sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_WEBINARSReturn one filtered page of webinars and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string ("ASC" | "DESC")
Sort webinars by name.
integer
Maximum webinars in this page (1-1000).
string
Filter webinars by name.
string
Opaque continuation cursor returned by a previous call; omit for page one.
string ("all" | "live" | "on_demand")
Filter webinars by type.
string ("upcoming" | "finished" | "published" | "unpublished")
Filter webinars by status.
string ("ASC" | "DESC")
Sort webinars by start time.
string ("ASC" | "DESC")
Sort webinars by creation time.
string
Filter webinars by campaign ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_WEBSITESReturn one filtered page of websites and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
string
End date-time for embedded statistics.
string ("ASC" | "DESC")
Sort by name.
integer
Maximum websites in this page (1-1000).
string
Start date-time for embedded statistics.
string
Filter websites by name.
string
Opaque continuation cursor from a previous call; omit for page one.
string ("ASC" | "DESC")
Sort by visit count.
string ("published" | "unpublished")
Filter websites by status.
string ("ASC" | "DESC")
Sort by creation time.
string ("ASC" | "DESC")
Sort by page view count.
string ("ASC" | "DESC")
Sort by modification time.
string ("ASC" | "DESC")
Sort by unique visitor count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_LIST_WORKFLOWSReturn one page of workflows and a continuation cursor.

Input Parameters

string
Comma-separated fields to return; the ID is always returned.
integer
Maximum workflows in this page (1-1000).
string
Opaque continuation cursor returned by a previous call; omit for page one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_SEARCH_CONTACTSSearch contacts using supplied conditions without creating or changing a saved search. Returns one page and a continuation cursor.

Input Parameters

string
Comma-separated fields to return.
array
required
Contact search sections.
string ("ASC" | "DESC")
Name sort direction.
integer
Maximum contacts in this page (1-1000).
string ("ASC" | "DESC")
Email sort direction.
string
Continuation cursor from a previous call.
string ("ASC" | "DESC")
Creation-date sort direction.
array
required
Subscription statuses included in the search.
string ("or" | "and")
required
Match any or all search sections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_SELECT_SUBJECT_AB_TEST_WINNERChoose the winning message variant for a subject A/B test.

Input Parameters

string
required
A/B test ID.
string
required
Message variant ID to select as the winner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_SEND_NEWSLETTER_DRAFTSend an existing newsletter draft using the supplied recipient and delivery settings.

Input Parameters

string
required
Newsletter draft ID.
object
required
Recipient selection and delivery settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_SEND_SMSImmediately send an SMS to selected GetResponse contacts or imported phone numbers. Requires a paid SMS plan or add-on.

Input Parameters

string
required
SMS message name.
string
required
SMS message content.
object
required
Sender and recipient settings for the selected recipients_type.
string ("contacts" | "importedNumbers")
required
Use contacts for GetResponse contacts or importedNumbers for manually supplied phone numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_SEND_TRANSACTIONAL_EMAILSend a direct or template-based transactional email. Requires a paid transactional-email plan or add-on.

Input Parameters

object
Optional statistics tag.
object
Body for a direct-content email.
string
Subject for a direct-content email.
object
Reply-to address reference.
object
Stored template for a template email.
object
required
Sender address reference.
object
required
Message recipients; at most eight total recipients are supported.
array
Files attached to the email.
string ("direct" | "template")
Whether to send direct content or a stored template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_SET_DEFAULT_FROM_ADDRESSSet an existing GetResponse ‘From’ address as the account default.

Input Parameters

string
required
The ‘From’ address ID to make the account default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_TRIGGER_CUSTOM_EVENTTrigger an existing custom event for a contact. This may start connected automation workflows.

Input Parameters

string
required
Name of an existing custom event.
array
Values for attributes defined on the custom event.
string
required
Contact ID for which to trigger the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_ACCOUNTUpdate supplied profile fields on the connected GetResponse account. Provide at least one mutable field.

Input Parameters

string
City.
string
Phone number.
string
State or region.
string
Street address.
string
Postal code.
string
Last name.
string
First name.
string ("12h" | "24h")
Account time notation.
string
Company name.
string ("50" | "250" | "500" | "more")
Company size bracket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_ACCOUNT_BADGEEnable or disable the selected GetResponse account badge type.

Input Parameters

string ("landing_page" | "website_builder_elegant" | "referral")
Account badge type.
string ("enabled" | "disabled")
required
Desired GetResponse badge status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_ACCOUNT_BLOCKLISTUpdate the account-wide blocklist. Omit additional_flags to replace all masks; use add or delete for incremental changes, optionally combined with noResponse.

Input Parameters

array
required
Blocklist masks to add, delete, or replace.
array
Optional operation flags. Use add or delete to modify existing masks; use noResponse to ask GetResponse to omit response content. Provide multiple flags as a list; they are sent as one comma-separated value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_ADDRESSUpdate only the supplied fields of an existing GetResponse address. Provide at least one mutable field.

Input Parameters

string
ZIP or postal code.
string
City.
string
Address label.
string
Phone number.
string
Company name.
string
First street-address line.
string
Second street-address line.
string
Province or state name.
string
Recipient last name.
string
required
The address ID to update.
string
Recipient first name.
string
ISO 3166-1 alpha-3 country code.
string
Province or state code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_AUTORESPONDERUpdate 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

string
Autoresponder name.
array
Message tracking flags.
string ("enabled" | "disabled")
Autoresponder status.
object
Message content.
string
Autoresponder message subject.
object
Reply-to address.
object
Sender address.
string
Campaign ID.
string ("true" | "false")
Whether to track message opens.
object
Delivery settings.
string
required
Autoresponder ID to update.
object
Autoresponder trigger conditions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_CALLBACK_CONFIGURATIONEnable or update the account-wide callback URL and event subscriptions. Provide at least one mutable field.

Input Parameters

string
Notification URL; required when enabling callbacks for the first time.
object
Callback event types to enable or disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_CAMPAIGNUpdate a GetResponse campaign (contact list) and its confirmation or profile settings.

Input Parameters

string
required
Unique campaign (contact list) name.
object
Postal-address settings.
object
Public campaign profile settings.
string ("true" | "false")
Whether this campaign is the account default.
string
required
Campaign ID to update.
object
Opt-in settings by subscription source.
object
Subscription confirmation settings.
string
ISO 639-1 campaign language code, also accepting zt, fs, and md.
object
Subscription notification settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_CAMPAIGN_BLOCKLISTAdd, delete, or replace blocklist masks for a campaign (contact list).

Input Parameters

array
required
Blocklist masks to add, delete, or replace.
string
required
Unique ID of the campaign (contact list).
array
Optional operation flags. Use add or delete to modify existing masks; use noResponse to ask GetResponse to omit response content. Separate multiple flags in a list; they are serialized as a comma-separated value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_CARTUpdate a cart and its selected variants. Provide at least one mutable field.

Input Parameters

string
required
Cart ID.
string
required
Shop ID.
string
External cart URL.
string
ISO 4217 currency code.
string
Contact ID that owns the cart.
string
External cart ID.
number
Total cart price excluding tax.
number
Total cart price including tax.
array
Variants selected in the cart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_CATEGORYUpdate a category’s supplied fields. Provide at least one mutable field.

Input Parameters

string
New external category URL.
string
New category name.
string
required
The shop ID.
string
New parent category ID.
boolean
Whether this is the default category.
string
required
The category ID.
string
New external category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_CONTACTUpdate 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

string
New contact name.
string
Contact note; null removes it.
array
Replacement set of contact tags.
string
New contact email address.
number
Contact score; null removes it.
object
Campaign to move the contact to.
string
required
Unique contact ID.
string
Autoresponder cycle day; null removes the contact from the cycle.
array
Replacement custom field values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_CUSTOM_EVENTUpdate a custom event definition and its attributes.

Input Parameters

string
required
Unique custom event name.
array
required
Complete collection of attributes for the custom event.
string
required
Custom event ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_CUSTOM_FIELDUpdate a custom field definition’s visibility and assigned values.

Input Parameters

string ("true" | "false")
required
Whether the custom field is visible to contacts, as a provider string boolean.
array
required
Complete list of values assigned to the custom field.
string
required
The custom field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_META_FIELDUpdate a meta field’s supplied fields. Provide at least one mutable field.

Input Parameters

string
New meta field name.
string
New meta field value.
string
required
The shop ID.
string ("string" | "integer")
New meta field value type.
string
New meta field description.
string
required
The meta field ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_ORDERUpdate the supplied fields of an ecommerce order. Provide at least one mutable body field; additional_flags alone does not update the order.

Input Parameters

string
New order status.
string
New associated cart ID.
string
required
The shop ID.
string
New ISO 4217 currency code.
string
required
The order ID.
string
New external order URL.
string
New contact ID for the order.
string
New order description.
string
New external order ID.
array
Complete replacement metadata collection for the order.
number
New total order price.
string
New exact ISO 8601 time the order was made.
string
New billing status.
number
New shipping price.
object
Complete replacement billing address; individual fields cannot be patched.
number
New total order tax.
string
Use skipAutomation to avoid triggering Make a purchase workflows.
object
Complete replacement shipping address; individual fields cannot be patched.
array
Complete replacement selected-variant collection for the order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_PREDEFINED_FIELDUpdate the value of an existing GetResponse predefined field.

Input Parameters

string
required
New predefined field value containing only ASCII letters and underscores.
string
required
The predefined field ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_PRODUCTUpdate a product and its nested ecommerce data. Provide at least one mutable field.

Input Parameters

string
External product URL.
string
Product name.
string
Product type.
string
Product vendor.
string
required
Shop ID.
array
Product variants.
array
Product categories.
string
required
Product ID.
string
External product ID.
array
Product meta fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_PRODUCT_VARIANTUpdate a product variant and its nested ecommerce data. Provide at least one mutable field.

Input Parameters

string
Unique stock-keeping unit.
string
External variant URL.
string
Variant name.
number
Price excluding tax.
array
Variant taxes.
array
Variant images.
string
Variant barcode.
string
required
Shop ID.
integer
Variant position.
integer
Available quantity.
number
Price including tax.
string
required
Product ID.
string
required
Variant ID.
string
Variant description.
string
External variant ID.
array
Variant meta fields.
number
Previous price excluding tax.
number
Previous price including tax.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_RSS_NEWSLETTERUpdate 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

string
Internal newsletter name.
array
Message tracking flags.
string ("custom" | "text" | "getresponse" | "legacy" | "html2")
Editor used to create the message.
string ("enabled" | "disabled")
RSS newsletter status.
object
Message content.
string
RSS message subject.
object
Reply-to address.
object
Sender address.
string
RSS feed URL.
object
Delivery and audience settings.
string
required
RSS newsletter ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_SAVED_CONTACT_SEARCHReplace a saved contact search’s name and condition sections.

Input Parameters

string
required
Unique saved-search name.
array
required
Replacement search sections.
array
Subscription statuses included in the search.
string ("or" | "and")
required
Match any or all search sections.
string
required
Saved contact search ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_SHOPUpdate a shop’s supplied fields. Provide at least one mutable field.

Input Parameters

string
New shop name.
string
New ISO 639-1 language locale.
string
required
The shop ID.
string
New ISO 4217 currency code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_SUPPRESSIONReplace 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

string
The new suppression list name. Omit to keep the current name.
array
required
Complete list of masks to assign to the suppression list.
string
required
The suppression list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_TAXUpdate a tax’s supplied fields. Provide at least one mutable field.

Input Parameters

string
New tax name.
number
New tax rate.
string
required
The tax ID.
string
required
The shop ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_TRANSACTIONAL_EMAIL_TEMPLATEUpdate the subject or content of a transactional email template. Provide at least one mutable field.

Input Parameters

object
New plain-text and/or HTML content.
string
New template subject.
string
required
Transactional email template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPDATE_WORKFLOWSet a workflow to active, inactive, or incomplete (draft).

Input Parameters

string ("active" | "inactive" | "incomplete")
required
New workflow status; incomplete represents a draft.
string
required
Workflow ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPLOAD_IMAGEUpload an image file to GetResponse Multimedia.

Input Parameters

object
required
Required image file. Provider semantics override the optional OpenAPI marker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPSERT_CONTACT_CUSTOM_FIELDSAdd or update a contact’s custom fields without removing other assigned custom fields.

Input Parameters

string
required
Unique contact ID.
array
required
Custom fields to add or update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPSERT_CONTACT_TAGSAdd tags to a contact without unassigning the contact’s existing tags.

Input Parameters

array
required
Tags to add without unassigning existing tags.
string
required
Unique contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPSERT_META_FIELDSAssign meta fields to a product without removing existing assignments.

Input Parameters

string
required
Shop ID.
string
required
Product ID.
array
required
Meta fields to assign without removing existing assignments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPSERT_PRODUCT_CATEGORIESAssign categories to a product and optionally set its default category without removing existing assignments.

Input Parameters

string
required
Shop ID.
array
required
Categories to assign without removing existing assignments.
string
required
Product ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GETRESPONSE_UPSERT_SAVED_SEARCH_CONTACT_CUSTOM_FIELDSSubmit 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

array
required
Custom fields to add or update on matching contacts.
string
required
Saved contact search ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not