> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/getresponse.md).

# GetResponse

GetResponse is an email marketing and automation platform. Manage contacts, tags, and custom fields, send newsletters and transactional email, and read campaign statistics from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector             | Authentication |
| --------------------- | -------------- |
| GetResponse (API Key) | API Key        |

#### GetResponse (API Key)

Connect to GetResponse to manage contacts and send campaigns.

**Set up in GetResponse**

1. Prepare the GetResponse account or service that the workflow will access. Grant access to the required resources and operations.
2. Create or obtain the API credential identified in the fields below. Use the provider instructions linked with those fields to find its key-management page.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **GetResponse (API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                            |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| API Key       | Yes      | Your GetResponse API key (Tools -> Integrations and API -> API). Keys unused for 90 days expire automatically. [Provider instructions](https://app.getresponse.com/api). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **GetResponse** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Contact

Add a new contact to a GetResponse campaign (contact list).

**Inputs**

| Field               | Type                      | Required | Description                                                                               |
| ------------------- | ------------------------- | -------- | ----------------------------------------------------------------------------------------- |
| Campaign            | select (string)           | Yes      | Campaign (contact list) to add the contact to. Options load from the selected connection. |
| Email Address       | string                    | Yes      | The contact's email address.                                                              |
| Name                | string                    | No       | Optional contact name.                                                                    |
| Day Of Cycle        | integer                   | No       | Optional autoresponder cycle day to start the contact on.                                 |
| Scoring             | number                    | No       | Optional initial contact score.                                                           |
| Tags                | multiple\_select (string) | No       | Optional tags to attach to the new contact. Options load from the selected connection.    |
| Custom Field Values | object                    | No       | Optional custom field values, keyed by field name.                                        |

**Outputs**

| Field       | Type    | Description                                            |
| ----------- | ------- | ------------------------------------------------------ |
| Accepted    | boolean | Whether GetResponse accepted the contact for creation. |
| Email       | string  | The submitted email address.                           |
| Campaign ID | string  | The campaign the contact was added to.                 |

#### Create or Update Contact

Create a contact, or update the one with the same email in the campaign.

**Inputs**

| Field         | Type            | Required | Description                                                                                    |
| ------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------- |
| Campaign      | select (string) | Yes      | Campaign (contact list) to upsert the contact into. Options load from the selected connection. |
| Email Address | string          | Yes      | The email address used to find or create the contact.                                          |
| Name          | string          | No       | Optional contact name.                                                                         |
| Day Of Cycle  | integer         | No       | Optional autoresponder cycle day.                                                              |
| Scoring       | number          | No       | Optional contact score.                                                                        |

**Outputs**

| Field       | Type    | Description                                                     |
| ----------- | ------- | --------------------------------------------------------------- |
| Operation   | string  | What happened: created, updated, or found.                      |
| Accepted    | boolean | Whether GetResponse accepted the request.                       |
| Contact ID  | string  | The contact's ID (empty when creation was queued).              |
| Email       | string  | The contact's email address.                                    |
| Campaign ID | string  | The campaign the contact belongs to.                            |
| Name        | string  | The contact's name.                                             |
| API Link    | string  | Direct API link to the contact (null when creation was queued). |

#### Find Contacts

Search contacts by email, name, campaign, origin, or creation date.

**Inputs**

| Field        | Type            | Required | Description                                                                                                                                                                 |
| ------------ | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Email        | string          | No       | Optional email address to search for.                                                                                                                                       |
| Name         | string          | No       | Optional name to search for.                                                                                                                                                |
| Campaign     | select (string) | No       | Optional campaign (contact list) to search within. Options load from the selected connection.                                                                               |
| Origin       | select (string) | No       | Optional origin to filter by. Available values: import, email, www, panel, leads, sale, api, survey, iphone, copy, landing\_page, webinar, website\_builder\_elegant, chat. |
| Created From | datetime        | No       | Only contacts created on or after this date.                                                                                                                                |
| Created To   | datetime        | No       | Only contacts created on or before this date.                                                                                                                               |
| Exact Match  | boolean         | No       | Match the search values exactly instead of partially.                                                                                                                       |
| Limit        | integer         | No       | Maximum contacts to return (default 100).                                                                                                                                   |

**Outputs**

| Field    | Type        | Description                                            |
| -------- | ----------- | ------------------------------------------------------ |
| Contacts | dict\_array | The matching contacts.                                 |
| Count    | integer     | Number of contacts returned.                           |
| Has More | boolean     | True if more contacts matched beyond the returned set. |

#### Get Contact

Fetch a contact's full details, including tags and custom fields.

**Inputs**

| Field   | Type            | Required | Description                                                      |
| ------- | --------------- | -------- | ---------------------------------------------------------------- |
| Contact | select (string) | Yes      | The contact to fetch. Options load from the selected connection. |

**Outputs**

| Field               | Type        | Description                                   |
| ------------------- | ----------- | --------------------------------------------- |
| Contact ID          | string      | The contact's ID.                             |
| Email               | string      | The contact's email address.                  |
| Name                | string      | The contact's name.                           |
| Campaign ID         | string      | The campaign (list) the contact belongs to.   |
| Campaign Name       | string      | The name of the contact's campaign.           |
| Origin              | string      | How the contact was added.                    |
| Note                | string      | The note stored on the contact.               |
| Day Of Cycle        | string      | The contact's autoresponder cycle day.        |
| Scoring             | number      | The contact's score.                          |
| Engagement Score    | integer     | The contact's engagement score (1-5).         |
| Created On          | string      | When the contact was created (ISO-8601).      |
| Changed On          | string      | When the contact was last changed (ISO-8601). |
| API Link            | string      | Direct API link to the contact.               |
| Tags                | dict\_array | The contact's tags.                           |
| Custom Field Values | dict\_array | The contact's custom field values.            |

#### Update Contact

Update a contact's name, email, note, campaign, cycle day, or score.

**Inputs**

| Field         | Type            | Required | Description                                                       |
| ------------- | --------------- | -------- | ----------------------------------------------------------------- |
| Contact       | select (string) | Yes      | The contact to update. Options load from the selected connection. |
| Name          | string          | No       | New contact name. An empty string clears it.                      |
| Email Address | string          | No       | New email address.                                                |
| Note          | textarea        | No       | New note. An empty string clears it.                              |
| Campaign      | select (string) | No       | Move the contact to this campaign (contact list).                 |
| Day Of Cycle  | integer         | No       | New autoresponder cycle day.                                      |
| Scoring       | number          | No       | New contact score.                                                |

**Outputs**

| Field               | Type        | Description                                   |
| ------------------- | ----------- | --------------------------------------------- |
| Contact ID          | string      | The contact's ID.                             |
| Email               | string      | The contact's email address.                  |
| Name                | string      | The contact's name.                           |
| Campaign ID         | string      | The campaign (list) the contact belongs to.   |
| Campaign Name       | string      | The name of the contact's campaign.           |
| Origin              | string      | How the contact was added.                    |
| Note                | string      | The note stored on the contact.               |
| Day Of Cycle        | string      | The contact's autoresponder cycle day.        |
| Scoring             | number      | The contact's score.                          |
| Engagement Score    | integer     | The contact's engagement score (1-5).         |
| Created On          | string      | When the contact was created (ISO-8601).      |
| Changed On          | string      | When the contact was last changed (ISO-8601). |
| API Link            | string      | Direct API link to the contact.               |
| Tags                | dict\_array | The contact's tags.                           |
| Custom Field Values | dict\_array | The contact's custom field values.            |

#### Delete Contact

Delete a contact from the account.

**Inputs**

| Field   | Type            | Required | Description                                                       |
| ------- | --------------- | -------- | ----------------------------------------------------------------- |
| Contact | select (string) | Yes      | The contact to delete. Options load from the selected connection. |

**Outputs**

| Field      | Type    | Description                      |
| ---------- | ------- | -------------------------------- |
| Deleted    | boolean | Whether the contact was deleted. |
| Contact ID | string  | The deleted contact's ID.        |

#### Add Tags to Contact

Add tags to a contact, by ID or by name (optionally creating them).

**Inputs**

| Field               | Type                      | Required | Description                                                                     |
| ------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------- |
| Contact             | select (string)           | Yes      | The contact to tag. Options load from the selected connection.                  |
| Tags                | multiple\_select (string) | No       | Existing tags to add to the contact. Options load from the selected connection. |
| Tag Names           | array                     | No       | Tag names to add (resolved to IDs; optionally created).                         |
| Create Missing Tags | boolean                   | No       | Create tags for names that do not exist yet (default: false).                   |

**Outputs**

| Field           | Type        | Description                          |
| --------------- | ----------- | ------------------------------------ |
| Contact ID      | string      | The tagged contact's ID.             |
| Tags            | dict\_array | The contact's tags after the update. |
| Created Tag IDs | array       | IDs of tags created on the fly.      |

#### Upsert Contact Custom Fields

Set custom field values on a contact, addressing fields by name.

**Inputs**

| Field               | Type            | Required | Description                                                       |
| ------------------- | --------------- | -------- | ----------------------------------------------------------------- |
| Contact             | select (string) | Yes      | The contact to update. Options load from the selected connection. |
| Custom Field Values | object          | Yes      | Custom field values, keyed by field name.                         |

**Outputs**

| Field               | Type        | Description                                         |
| ------------------- | ----------- | --------------------------------------------------- |
| Contact ID          | string      | The updated contact's ID.                           |
| Custom Field Values | dict\_array | The contact's custom field values after the update. |

#### List Campaigns

List the campaigns (contact lists) on the account.

**Inputs**

| Field       | Type    | Required | Description                                |
| ----------- | ------- | -------- | ------------------------------------------ |
| Name Filter | string  | No       | Optional campaign name to filter by.       |
| Limit       | integer | No       | Maximum campaigns to return (default 100). |

**Outputs**

| Field     | Type        | Description                                           |
| --------- | ----------- | ----------------------------------------------------- |
| Campaigns | dict\_array | The campaigns (contact lists).                        |
| Count     | integer     | Number of campaigns returned.                         |
| Has More  | boolean     | True if more campaigns exist beyond the returned set. |

#### Create Newsletter

Create a newsletter and send it now, schedule it, or save a draft.

**Inputs**

| Field                          | Type                      | Required | Description                                                                                                   |
| ------------------------------ | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Campaign                       | select (string)           | Yes      | Campaign (contact list) the newsletter belongs to and sends to. Options load from the selected connection.    |
| From Address                   | select (string)           | Yes      | Verified sender address to send from. Options load from the selected connection.                              |
| Reply-To Address               | select (string)           | No       | Optional reply-to address. Options load from the selected connection.                                         |
| Subject                        | string                    | Yes      | The newsletter subject line.                                                                                  |
| Internal Name                  | string                    | No       | Optional internal name shown inside GetResponse.                                                              |
| HTML Content                   | textarea                  | No       | The newsletter body in HTML.                                                                                  |
| Plain Text Content             | textarea                  | No       | The newsletter body in plain text.                                                                            |
| Type                           | select (string)           | No       | broadcast sends the newsletter; draft only saves it (default: broadcast). Available values: broadcast, draft. |
| Scheduled Send Time            | datetime                  | No       | Optional future send time; omit to send immediately.                                                          |
| Additional Recipient Campaigns | multiple\_select (string) | No       | Optional extra campaigns to send the newsletter to. Options load from the selected connection.                |

**Outputs**

| Field         | Type   | Description                                       |
| ------------- | ------ | ------------------------------------------------- |
| Newsletter ID | string | The created newsletter's ID.                      |
| Status        | string | The newsletter's status.                          |
| Type          | string | The newsletter's type (broadcast or draft).       |
| Subject       | string | The newsletter's subject.                         |
| Campaign ID   | string | The campaign the newsletter is assigned to.       |
| Send On       | string | The scheduled send time (ISO-8601), if scheduled. |
| API Link      | string | Direct API link to the newsletter.                |

#### Get Newsletter Statistics

Fetch a newsletter's sends, opens, clicks, bounces, and unsubscribes.

**Inputs**

| Field      | Type            | Required | Description                                                                                                       |
| ---------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| Newsletter | select (string) | Yes      | The newsletter to get statistics for. Options load from the selected connection.                                  |
| Group By   | select (string) | No       | Time bucket for the rows: total, hour, day, or month (default: total). Available values: total, hour, day, month. |
| From       | datetime        | No       | Only count data from this date.                                                                                   |
| To         | datetime        | No       | Only count data up to this date.                                                                                  |
| Limit      | integer         | No       | Maximum rows to return (default 100).                                                                             |

**Outputs**

| Field      | Type        | Description                                      |
| ---------- | ----------- | ------------------------------------------------ |
| Statistics | dict\_array | Statistics rows per time interval.               |
| Has More   | boolean     | True if more rows exist beyond the returned set. |

#### Send Transactional Email

Send a one-off transactional email from a verified sender address.

**Inputs**

| Field              | Type            | Required | Description                                                                                           |
| ------------------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------- |
| From Address       | select (string) | Yes      | Verified sender address to send from. Options load from the selected connection.                      |
| To                 | string          | Yes      | The recipient's email address.                                                                        |
| To Name            | string          | No       | Optional recipient name.                                                                              |
| Cc                 | array           | No       | Optional Cc addresses.                                                                                |
| Bcc                | array           | No       | Optional Bcc addresses.                                                                               |
| Reply-To Address   | select (string) | No       | Optional reply-to address. Options load from the selected connection.                                 |
| Subject            | string          | Yes      | The message subject.                                                                                  |
| HTML Content       | textarea        | No       | The message body in HTML.                                                                             |
| Plain Text Content | textarea        | No       | The message body in plain text.                                                                       |
| Statistics Tag     | select (string) | No       | Optional tag used to group transactional email statistics. Options load from the selected connection. |

**Outputs**

| Field                  | Type   | Description                          |
| ---------------------- | ------ | ------------------------------------ |
| Transactional Email ID | string | The queued transactional email's ID. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/getresponse.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
