GetResponse

Create and list contacts in GetResponse email marketing.

MarketingAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
create-contact
create-newsletter
create-or-update-contact
custom_api_call
find-campaign-list
find-contact
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("getresponse", "create-contact", {
    "campaignId": "<campaignId>",
    "email": "<email address>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("GetResponse answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "getresponse-create-contact",
  name: "GetResponse: Create Contact",
  description: "Calls GetResponse when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("getresponse", {
      "action": "create-contact",
      "campaignId": "<campaignId>",
      "email": "<email address>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/getresponse/create-contact" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"campaignId":"<campaignId>","email":"<email address>"}}'

Actions

create-contactin catalog

Create Contact. Creates a new contact in a GetResponse campaign.

Also accepted as create_contact.

Input	Type	Description
`campaignId`required	id (picked from your account)	Select the campaign list to use.
`email`required	text	The email address of the contact to create.
`name`optional	text	The contact name as it should appear in GetResponse.

Create Newsletter. Creates a newsletter and queues it to send to the selected campaign.

Input	Type	Description
`campaignId`required	id (picked from your account)	Select the campaign list to use.
`fromFieldId`required	id (picked from your account)	Select the verified sender address to use.
`replyToFieldId`optional	id (picked from your account)	Select the verified sender address to use.
`subject`required	text	The subject line for the newsletter.
`name`optional	text	An internal name for the newsletter inside GetResponse. Leave empty to use the subject.
`htmlContent`optional	long text	The newsletter content in HTML format.
`plainContent`optional	long text	The plain text version of the newsletter content.

create-or-update-contact

Create or Update Contact. Creates a contact or updates the existing contact with the same email in the selected campaign.

Input	Type	Description
`campaignId`required	id (picked from your account)	Select the campaign list to use.
`email`required	text	The email address used to find or create the contact.
`name`optional	text	The contact name as it should appear in GetResponse.

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

find-campaign-list

Find Campaign List. Finds campaign lists by name.

Input	Type	Description
`name`optional	text	Enter part or all of the campaign list name. Leave empty to return the first lists in the account.
`limit`optional	number	The maximum number of campaign lists to return.

find-contact

Find Contact. Finds a contact by email address.

Input	Type	Description
`email`required	text	The email address of the contact to find.
`campaignId`optional	id (picked from your account)	Select the campaign list to use.

Details

Id: getresponse
Category: Marketing
Tags: email, marketing-automation, landing-pages, webinars
Package: @activepieces/piece-getresponse@0.0.2
Tier: Community