The GetResponse connector lets your AI agent act in each user's GetResponse account. Each user connects their own GetResponse API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 50 tools.
- Tools
- 50
- What they doRead · write · destructive
- 33 · 14 · 333 read14 write3 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the GetResponse connection
In AgentKit > Connections, create a GetResponse connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'getresponse'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize GetResponse:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'getresponse_account_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "getresponse"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize GetResponse:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="getresponse_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their GetResponse credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolgetresponse_account_getGet the account details (owner, company, country, time zone).Read-onlyGet Account
Get the account details (owner, company, country, time zone). Returns an object with accountId, email, countryCode, industryTag, timeZone, href, firstName, lastName, companyName, phone, and more. Use getresponse_account_get to check the connection.
Inputs
This tool takes no inputs.
getresponse_autoresponder_getGet one autoresponder.Read-onlyGet Autoresponder
Get one autoresponder. Returns an object with clickTracks, campaign, editor, sendSettings, autoresponderId, href, name, subject, campaignId, status, and more. Use getresponse_autoresponder_get for one autoresponder.
Inputs
autoresponder_idstringrequired- Autoresponder ID. Example: pV3r
getresponse_autoresponder_statistics_getGet sends, opens and clicks for an autoresponder.Read-onlyGet Autoresponder Statistics
Get sends, opens and clicks for an autoresponder. Returns an array of objects with timeInterval, sent, totalOpened, totalHumanOpened, uniqueOpened, uniqueHumanOpened, totalClicked, totalHumanClicked. Use getresponse_autoresponder_statistics_get to measure a follow-up.
Inputs
autoresponder_idstringrequired- Autoresponder ID. Example: pV3r
created_on_fromstring- Created on or after this date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- Created on or before this date, YYYY-MM-DD. Example: 2026-11-30
group_bystring- Group results by time interval. One of: total, hour, day, month. Example: totalone of
totalhourdaymonth pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
getresponse_autoresponders_listList autoresponders (cycle-day follow-up emails).Read-onlyList Autoresponders
List autoresponders (cycle-day follow-up emails). Returns an array of objects with campaign, sendSettings, autoresponderId, href, name, subject, campaignId, status. Use getresponse_autoresponders_list to review follow-ups.
Inputs
campaign_idstring- Search autoresponder by campaign ID. Example: abc123
created_on_fromstring- Created on or after this date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- Created on or before this date, YYYY-MM-DD. Example: 2026-11-30
namestring- Search autoresponder by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
sort_click_ratestring- Sort by click rate. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_day_of_cyclestring- Sort by cycle day. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_deliveredstring- Sort by delivered. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_open_ratestring- Sort by open rate. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_subjectstring- Sort by subject. One of: ASC, DESC. Example: ASCone of
ASCDESC statusstring- Search autoresponder by status. One of: enabled, disabled. Example: enabledone of
enableddisabled subjectstring- Search autoresponder by subject. Example: Q4 renewal
getresponse_campaign_contacts_listList the contacts in one list.Read-onlyList Contacts in List
List the contacts in one list. Returns an array of objects with note, ipAddress, contactId, name, origin, timeZone, activities, changedOn. Use getresponse_campaign_contacts_list for one list. Use getresponse_contacts_list across lists.
Inputs
campaign_idstringrequired- List (campaign) ID, from getresponse_campaigns_list. Example: pV3r
created_on_fromstring- Created on or after this date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- Created on or before this date, YYYY-MM-DD. Example: 2026-11-30
emailstring- Search contacts by email. Example: jane@example.com
namestring- Search contacts by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
getresponse_campaign_getGet one list (campaign) with its opt-in, confirmation and notification settings.Read-onlyGet List
Get one list (campaign) with its opt-in, confirmation and notification settings. Returns an object with campaignId, name, techName, languageCode, isDefault, createdOn, href, postal, confirmation, optinTypes, and more. Use getresponse_campaign_get for one list.
Inputs
campaign_idstringrequired- List (campaign) ID, from getresponse_campaigns_list. Example: pV3r
getresponse_campaign_statistics_summary_getGet the summary statistics (subscribers, open and click rates) for lists.Read-onlyGet List Statistics
Get the summary statistics (subscribers, open and click rates) for lists. Returns an array of objects. Use getresponse_campaign_statistics_summary_get to compare lists.
Inputs
campaign_idstringrequired- List IDs, comma-separated. Example: pV3r
getresponse_campaigns_listList the contact lists (called campaigns in the API).Read-onlyList Lists
List the contact lists (called campaigns in the API). Returns an array of objects with description, campaignId, name, techName, languageCode, isDefault, createdOn, href. Use getresponse_campaigns_list to find a campaignId.
Inputs
is_defaultboolean- Retrieve campaigns (contact lists) depending on whether they are marked as default (isDefault = true) Example: True
namestring- Retrieve campaigns (contact lists) filtered by name. Example: campaign_name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
getresponse_contact_activities_listList the email activity of a contact (sends, opens, clicks).Read-onlyList Contact Activities
List the email activity of a contact (sends, opens, clicks). Returns an array of objects with activity, subject, createdOn, previewUrl, resource, clickTrack. Use getresponse_contact_activities_list to see how a contact engages.
Inputs
contact_idstringrequired- Contact ID, from getresponse_contacts_list. Example: pV3r
created_on_fromstring- From date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- To date, YYYY-MM-DD. Example: 2026-11-30
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
getresponse_contact_getGet one contact with list, tags, custom fields, scoring and engagement.Read-onlyGet Contact
Get one contact with list, tags, custom fields, scoring and engagement. Returns an object with geolocation, tags, customFieldValues, note, ipAddress, contactId, name, origin, timeZone, activities, and more. Use getresponse_contact_get for one contact.
Inputs
contact_idstringrequired- Contact ID, from getresponse_contacts_list. Example: pV3r
getresponse_contacts_listList contacts across lists, filtered by email, name, list, origin or dates.Read-onlyList Contacts
List contacts across lists, filtered by email, name, list, origin or dates. Returns an array of objects with note, ipAddress, contactId, name, origin, timeZone, activities, changedOn. Use getresponse_contacts_list to find a contactId. Use getresponse_contacts_search for segment conditions.
Inputs
campaign_idstring- List ID to filter by. Example: pV3r
created_on_fromstring- Created on or after this date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- Created on or before this date, YYYY-MM-DD. Example: 2026-11-30
emailstring- Email to search for (partial match). Example: jane@example.com
namestring- Name to search for. Example: Jane
originstring- How the contact was added. One of: import, email, www, panel, leads, sale, api, survey, iphone, copy, landing_page, webinar, website_builder_elegant, chat, course, premium_newsletter. Example: apione of
importemailwwwpanelleadssaleapisurveyiphonecopylanding_pagewebinarwebsite_builder_elegantchatcoursepremium_newsletter pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
sort_created_onstring- Sort by creation date. One of: ASC, DESC. Example: DESCone of
ASCDESC
getresponse_contacts_searchFind contacts that match segment conditions (for example opened a message, has a tag, custom field value).Read-onlySearch Contacts
Find contacts that match segment conditions (for example opened a message, has a tag, custom field value). Returns an array of objects with contactId, name, email, origin, dayOfCycle, createdOn, campaign, score. Use getresponse_contacts_search for advanced filters. Use getresponse_contacts_list for simple lookups.
Inputs
sectionarrayrequired- Condition sections, each with a campaignIdsList, a logicOperator and conditions. Example: [{"campaignIdsList": ["pV3r"], "logicOperator": "or", "subscriberCycle": ["receiving_autoresponder", "not_receiving_autoresponder"], "subscriptionDate": "all_time", "conditions": [{"conditionType": "email", "operatorType": "string_operator", "operator": "contains", "value": "@example.com"}]}]
section_logic_operatorstringrequired- How sections combine. One of: or, and. Example: orone of
orand subscribers_typearrayrequired- Which subscribers to search. Example: ["subscribed"]
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
sort_created_onstring- Sort by creation date. One of: ASC, DESC. Example: ascone of
ASCDESC
getresponse_custom_events_listList the custom events defined for automation.Read-onlyList Custom Events
List the custom events defined for automation. Returns an array of objects with customEventId, createdOn, href, name, attributes. Use getresponse_custom_events_list to find an event name.
Inputs
has_attributesstring- Search custom events with or without attributes. One of: true, false. Example: trueone of
truefalse namestring- Search custom events by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
getresponse_custom_field_getGet one custom field definition with its allowed values.Read-onlyGet Custom Field
Get one custom field definition with its allowed values. Returns an object with customFieldId, href, name, type, valueType, format, fieldType, hidden, values. Use getresponse_custom_field_get for one field.
Inputs
custom_field_idstringrequired- Custom field ID, from getresponse_custom_fields_list. Example: pV3r
getresponse_custom_fields_listList contact custom field definitions.Read-onlyList Custom Fields
List contact custom field definitions. Returns an array of objects with customFieldId, href, name, type, valueType, format, fieldType, hidden. Use getresponse_custom_fields_list to find a customFieldId.
Inputs
namestring- Field name to search for. Example: plan
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
getresponse_forms_listList sign-up forms.Read-onlyList Forms
List sign-up forms. Returns an array of objects with formId, webformId, name, href, hasVariants, scriptUrl, status, createdOn. Use getresponse_forms_list to see where contacts sign up.
Inputs
campaign_idstring- Search forms assigned to this list (campaign). You can pass multiple comma-separated values, eg. Xd1P,sC7r. Example: abc123
created_on_fromstring- Created on or after this date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- Created on or before this date, YYYY-MM-DD. Example: 2026-11-30
namestring- Search forms by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
statusstring- Search by status. Note: disabled includes both unpublished and draft and enabled equals published. One of: enabled, disabled, published, unpublished, draft. Example: enabledone of
enableddisabledpublishedunpublisheddraft
getresponse_from_fields_listList the 'From' addresses that can send email.Read-onlyList From Addresses
List the 'From' addresses that can send email. Returns an array of objects with fromFieldId, href, email, rewrittenEmail, name, isActive, isDefault, createdOn. Use getresponse_from_fields_list to find a fromFieldId for newsletters and transactional email.
Inputs
emailstring- Search 'From' address by email. Example: jane@example.com
is_activeboolean- Search only active 'From' addresses. Example: True
is_defaultboolean- Search only default 'From' address. Example: True
namestring- Search 'From' address by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
sort_created_onstring- Sort 'From' address by date. One of: ASC, DESC. Example: ASCone of
ASCDESC
getresponse_imports_listList contact imports with their status.Read-onlyList Imports
List contact imports with their status. Returns an array of objects with importId, campaign, status, statistics, errorStatistics, createdOn, finishedOn, href. Use getresponse_imports_list to check an import.
Inputs
campaign_idstring- Search imports by campaignId. Example: abc123
created_on_fromstring- Created on or after this date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- Created on or before this date, YYYY-MM-DD. Example: 2026-11-30
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
sort_added_contactsstring- Sort imports by inserted contact count. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_campaign_namestring- Sort imports by campaign name. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_finished_onstring- Sort imports by finish date. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_invalid_contactsstring- Sort imports by invalid contact count. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_statusstring- Sort imports by status (uploaded, to_review, approved, finished, rejected, canceled) One of: ASC, DESC. Example: ASCone of
ASCDESC sort_updated_contactsstring- Sort imports by updated contact count. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_uploaded_contactsstring- Sort imports by uploaded contact count. One of: ASC, DESC. Example: ASCone of
ASCDESC
getresponse_landing_pages_listList landing pages.Read-onlyList Landing Pages
List landing pages. Returns an array of objects with statistics, lpsId, href, name, status, domainUrl, thumbnailUrl, isChatsEnabled. Use getresponse_landing_pages_list to review pages.
Inputs
namestring- Search landing pages by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
sort_created_atstring- Sort landing pages by creation date. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_leadsstring- Sort landing pages by number of leads. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_subscription_ratestring- Sort by subscription rate. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_updated_atstring- Sort landing pages by modification date. One of: ASC, DESC. Example: ASCone of
ASCDESC sort_visitsstring- Sort by number of page visits. One of: ASC, DESC. Example: ASCone of
ASCDESC stats_fromstring- Show statistics for landing pages from this date. Example: 2026-01-31T12:00:00Z
stats_tostring- Show statistics for landing pages to this date. Example: 2026-01-31T12:00:00Z
statusstring- Search landing pages by status. One of: published, unpublished. Example: publishedone of
publishedunpublished
getresponse_shop_orders_listList the orders of a shop.Read-onlyList Shop Orders
List the orders of a shop. Returns an array of objects with orderId, href, contactId, orderUrl, externalId, totalPrice, totalPriceTax, currency. Use getresponse_shop_orders_list for purchase history.
Inputs
shop_idstringrequired- Shop ID, from getresponse_shops_list. Example: pV3r
descriptionstring- Search order by description. Example: Short description
external_idstring- Search order by external ID. Example: abc123
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
processed_at_fromstring- Show orders processed from this date. Example: 2026-01-31T12:00:00Z
processed_at_tostring- Show orders processed to this date. Example: 2026-01-31T12:00:00Z
statusstring- Search order by status. Example: example
getresponse_shop_products_listList the products of a shop.Read-onlyList Shop Products
List the products of a shop. Returns an array of objects with productId, href, name, type, url, vendor, externalId, categories. Use getresponse_shop_products_list to see the catalogue.
Inputs
shop_idstringrequired- Shop ID, from getresponse_shops_list. Example: pV3r
categorystring- Search products by category name. Example: example
category_idstring- Search products by category ID. Example: abc123
created_on_fromstring- Created on or after this date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- Created on or before this date, YYYY-MM-DD. Example: 2026-11-30
external_idstring- Search products by external ID. Example: abc123
meta_field_namesstring- Search products by meta field name (the list of names must be separated by a comma [,]) Example: Example name
meta_field_valuesstring- Search products by meta field value (the list of values must be separated by a comma [,]) Example: example
namestring- Search products by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
variant_namestring- Search products by product variant name. Example: Example name
vendorstring- Search products by vendor. Example: example
getresponse_shops_listList the ecommerce shops connected to the account.Read-onlyList Shops
List the ecommerce shops connected to the account. Returns an array of objects with shopId, href, name, locale, currency, createdOn, updatedOn. Use getresponse_shops_list to find a shopId.
Inputs
namestring- Search shop by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
getresponse_suppressions_listList suppression lists (addresses and domains never to email).Read-onlyList Suppression Lists
List suppression lists (addresses and domains never to email). Returns an array of objects with suppressionId, name, createdOn, href. Use getresponse_suppressions_list before sending.
Inputs
created_on_fromstring- Created on or after this date, YYYY-MM-DD. Example: 2026-11-01
created_on_tostring- Created on or before this date, YYYY-MM-DD. Example: 2026-11-30
namestring- Search suppressions by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
sort_namestring- Sort by name. One of: ASC, DESC. Example: ASCone of
ASCDESC
getresponse_transactional_email_getGet one sent transactional email with its recipient status.Read-onlyGet Transactional Email
Get one sent transactional email with its recipient status. Returns an object with fromField, replyTo, subject, tag, recipients, href, transactionalEmailId. Use getresponse_transactional_email_get to check delivery.
Inputs
transactional_email_idstringrequired- Transactional email ID. Example: tRe4i
getresponse_transactional_emails_listList sent transactional emails.Read-onlyList Transactional Emails
List sent transactional emails. Returns an array of objects with transactionalEmailId, fromField, recipients, subject, tag, href. Use getresponse_transactional_emails_list to find a sent message.
Inputs
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
sent_on_fromstring- Search transactional emails sent from this date. Example: 2018-04-15
sent_on_tostring- Search transactional emails sent to this date. Example: 2018-04-15
tag_idstring- Search transactional emails with a specific tag ID. Example: abc123
taggedstring- Search tagged/untagged transactional emails. One of: true, false. Example: trueone of
truefalse
getresponse_transactional_templates_listList transactional email templates.Read-onlyList Transactional Templates
List transactional email templates. Returns an array of objects with templateId, href, subject, createdOn, updatedOn, editor. Use getresponse_transactional_templates_list to find a template_id.
Inputs
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
subjectstring- Search templates by subject. Example: Q4 renewal
getresponse_webinars_listList webinars.Read-onlyList Webinars
List webinars. Returns an array of objects with webinarId, href, createdOn, startsOn, webinarUrl, status, type, campaigns. Use getresponse_webinars_list to find upcoming webinars.
Inputs
campaign_idstring- The list of campaign resource IDs (string separated with ',') Example: abc123
namestring- Search webinars by name. Example: Example name
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
statusstring- Search webinars by status. One of: upcoming, finished, published, unpublished. Example: upcomingone of
upcomingfinishedpublishedunpublished typestring- Search webinars by type. One of: all, live, on_demand. Example: allone of
allliveon_demand
getresponse_workflow_getGet one automation workflow.Read-onlyGet Workflow
Get one automation workflow. Returns an object with workflowId, name, status, dateStart, dateStop, subscriberStatistics. Use getresponse_workflow_get for one workflow.
Inputs
workflow_idstringrequired- Workflow ID. Example: 1234
getresponse_workflows_listList marketing automation workflows with their status.Read-onlyList Workflows
List marketing automation workflows with their status. Returns an array of objects with workflowId, name, status, dateStart, dateStop, subscriberStatistics. Use getresponse_workflows_list to find a workflow.
Inputs
pageinteger- Page number, starting at 1. Example: 1
per_pageinteger- Results per page (up to 1000, default 100). Example: 100
getresponse_campaign_createCreate a contact list (campaign).WriteCreate List
Create a contact list (campaign). Returns an object with campaignId, name, techName, languageCode, isDefault, createdOn, href, postal, confirmation, optinTypes, and more. Use getresponse_campaign_create for a new list.
Inputs
namestringrequired- List name (lowercase letters, digits and underscores). Example: newsletter_2026
is_defaultstring- Set to true to make it the default list. One of: true, false. Example: falseone of
truefalse language_codestring- Language code. Example: EN
getresponse_campaign_updateUpdate a list name or settings.WriteUpdate List
Update a list name or settings. Returns an object with campaignId, name, techName, languageCode, isDefault, createdOn, href, postal, confirmation, optinTypes, and more. Use getresponse_campaign_update to rename a list.
- Idempotent
Inputs
campaign_idstringrequired- List (campaign) ID, from getresponse_campaigns_list. Example: pV3r
is_defaultstring- Is the campaign default. One of: true, false. Example: trueone of
truefalse language_codestring- The campaign language code according to ISO 639-1, plus: zt - Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian. Example: EN
namestring- New list name. Example: newsletter_main
getresponse_contact_createAdd a contact to a list.WriteCreate Contact
Add a contact to a list. GetResponse adds it asynchronously and returns no body. Returns 202 Accepted with an empty body; the contact appears after processing. Use getresponse_contact_create to subscribe someone. Confirm with getresponse_contacts_list.
Inputs
campaign_idstringrequired- List (campaign) ID to add the contact to. Example: pV3r.
emailstringrequired- Email address (partial match in filters). Example: jane@example.com
custom_field_valuesarray- Custom field values, each {"customFieldId": "...", "value": ["..."]}. Example: [{"customFieldId": "kL", "value": ["premium"]}].
day_of_cyclestring- Autoresponder cycle day to start at; leave empty to not enrol. Example: 0.
ip_addressstring- Subscriber IP address. Example: 203.0.113.10.
namestring- Name. Example: Jane Doe
tagsarray- Tags to apply, each {"tagId": "..."}. Example: [{"tagId": "Xw"}].
getresponse_contact_custom_fields_upsertSet custom field values on a contact (other fields stay).WriteSet Contact Custom Fields
Set custom field values on a contact (other fields stay). Returns an array of objects with customFieldId, values. Use getresponse_contact_custom_fields_upsert to update profile data.
- Idempotent
Inputs
contact_idstringrequired- Contact ID, from getresponse_contacts_list. Example: pV3r
custom_field_valuesarrayrequired- Custom field values, each {"customFieldId": "...", "value": ["..."]}. Example: [{"customFieldId": "kL", "value": ["premium"]}]
getresponse_contact_updateUpdate a contact; fields you leave out stay as they are.WriteUpdate Contact
Update a contact; fields you leave out stay as they are. Returns an object with geolocation, tags, customFieldValues, note, ipAddress, contactId, name, origin, timeZone, activities, and more. Use getresponse_contact_update to change a contact name, list, cycle day, note, tags or custom fields.
- Idempotent
Inputs
contact_idstringrequired- Contact ID, from getresponse_contacts_list. Example: pV3r
campaign_idstring- Move the contact to this list. Example: pV3r.
custom_field_valuesarray- Custom field values; replaces the current values. Example: [{"customFieldId": "kL", "value": ["premium"]}].
day_of_cyclestring- Autoresponder cycle day. Example: 3.
namestring- Name. Example: Jane Doe
notestring- Note on the contact. Example: Met at the trade fair.
scoringnumber- Contact score. Example: 10.
tagsarray- Tags; replaces the current tags. Example: [{"tagId": "Xw"}].
getresponse_custom_event_triggerFire a custom event for a contact, which can start automation workflows.WriteTrigger Custom Event
Fire a custom event for a contact, which can start automation workflows. Returns the JSON response from the API. Use getresponse_custom_event_trigger to tell GetResponse something happened in your app.
Inputs
contact_idstringrequired- Contact ID. Example: pV3r
namestringrequired- Custom event name, from getresponse_custom_events_list. Example: trial_started
attributesarray- Event attributes, each {"name": "...", "value": "..."}. Example: [{"name": "plan", "value": "pro"}]
getresponse_custom_field_createCreate a contact custom field.WriteCreate Custom Field
Create a contact custom field. Returns an object with customFieldId, href, name, type, valueType, format, fieldType, hidden, values. Use getresponse_custom_field_create to store new profile data.
Inputs
formatstringrequired- Field format. One of: text, textarea, radio, checkbox, single_select, multi_select. Example: textone of
texttextarearadiocheckboxsingle_selectmulti_select hiddenstringrequired- Set to true to hide the field on forms. One of: true, false. Example: falseone of
truefalse namestringrequired- Field name (lowercase letters, digits, underscores). Example: plan
typestringrequired- Field type. One of: string, number, date, datetime, country, currency, phone, gender, ip, url. Example: textone of
stringnumberdatedatetimecountrycurrencyphonegenderipurl valuesarrayrequired- Allowed values for choice fields; empty for free text. Example: []
getresponse_from_field_createAdd a 'From' address; GetResponse emails it a confirmation link.WriteCreate From Address
Add a 'From' address; GetResponse emails it a confirmation link. Returns an object with fromFieldId, href, email, rewrittenEmail, name, isActive, isDefault, createdOn, domain. Use getresponse_from_field_create to add a new sender.
Inputs
emailstringrequired- Sender email address. Example: news@example.com
namestringrequired- Sender name. Example: Acme News
getresponse_tag_createCreate a contact tag.WriteCreate Tag
Create a contact tag. Returns an object with tagId, createdAt, name, color. Use getresponse_tag_create before tagging contacts.
Inputs
namestringrequired- Tag name (letters, digits, underscores). Example: vip_customer
getresponse_transactional_email_sendSend one transactional email with your own content or a saved template (needs the transactional email add-on).WriteSend Transactional Email
Send one transactional email with your own content or a saved template (needs the transactional email add-on). Returns an object with transactionalEmailId. Use getresponse_transactional_email_send for receipts and notifications. Use getresponse_newsletter_create for broadcasts.
Inputs
content_typestringrequired- Direct to send subject and content, template to use a saved template. One of: direct, template. Example: direct.one of
directtemplate from_field_idstringrequired- From address ID. Example: V.
to_emailstringrequired- Recipient email. Example: jane@example.com.
htmlstring- HTML content (for direct content). Example: Your order has shipped.
plainstring- Plain-text content (for direct content). Example: Your order has shipped.
subjectstring- Subject (for direct content). Example: Your order has shipped.
tag_idstring- Tag ID for statistics. Example: vBd5.
template_idstring- Template ID (for template content), from getresponse_transactional_templates_list. Example: Ykz.
template_variablesobject- Template variables. Example: {"order_id": "1001"}.
to_namestring- Recipient name. Example: Jane Doe.
getresponse_workflow_status_updateTurn an automation workflow on or off.WriteActivate or Pause Workflow
Turn an automation workflow on or off. Returns an object with workflowId, name, status, dateStart, dateStop, subscriberStatistics. Use getresponse_workflow_status_update to pause or resume automation.
- Idempotent
Inputs
statusstringrequired- New status. One of: active, inactive, incomplete. Example: activeone of
activeinactiveincomplete workflow_idstringrequired- Workflow ID. Example: 1234
getresponse_contact_deleteDelete a contact from its list.DestructiveDelete Contact
Delete a contact from its list. Returns an empty response on success. Use getresponse_contact_delete to remove a contact.
- Idempotent
Inputs
contact_idstringrequired- Contact ID, from getresponse_contacts_list. Example: pV3r
ip_addressstring- IP address of the person who asked to be removed. Example: 203.0.113.10
message_idstring- ID of the message whose unsubscribe link triggered the removal, if any. Example: Ab
getresponse_tag_deleteDelete a tag and remove it from all contacts.DestructiveDelete Tag
Delete a tag and remove it from all contacts. Returns an empty response on success. Use getresponse_tag_delete to retire a tag.
- Idempotent
Inputs
tag_idstringrequired- Tag ID, from getresponse_tags_list. Example: pV3r
No tools match.