Add contacts and trigger autoresponders and email marketing campaigns via the GetResponse API.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

GetResponse

Add contacts and trigger autoresponders and email marketing campaigns via the GetResponse API v3.

In GetResponse a campaign is a contact list. Adding a contact to a campaign (list) enrolls them in that list's autoresponders and automation — so create-contact is both how you grow a list and how you fire its autoresponder sequence.

Base URL: https://api.getresponse.com/v3
Auth: X-Auth-Token: api-key <apiKey> (plain API key — no OAuth)
Credential-based: no (pass the key as the apiKey input)

Operations

operation	method & path	purpose
`get-contacts`	`GET /contacts`	List contacts; filter by `email` or `campaignId`
`create-contact`	`POST /contacts`	Add a contact to a campaign (list); triggers that list's autoresponders
`get-campaigns`	`GET /campaigns`	List campaigns (contact lists)
`get-autoresponders`	`GET /autoresponders`	List autoresponders
`get-newsletters`	`GET /newsletters`	List newsletters (broadcast emails)

Inputs

input	required	used by	notes
`apiKey`	yes	all	GetResponse API key
`operation`	yes	all	one of the operations above
`email`	create-contact	get-contacts, create-contact	contact email
`campaignId`	create-contact	get-contacts, create-contact	campaign/list id
`name`	no	create-contact	contact name
`dayOfCycle`	no	create-contact	autoresponder day-of-cycle start
`perPage`	no	all GETs	results per page (max 1000, default 100)
`page`	no	all GETs	page number (1-based)

The tool always publishes result (the raw JSON response body as a string) and status (the HTTP status code). POST /contacts returns 202 Accepted with an empty body on success — the add is queued asynchronously.

API key setup

Log in to GetResponse.
Go to Tools > Integrations & API > API.
Click Generate API key, name it, and copy the key.
Pass that value as the apiKey input.

The key is sent in the X-Auth-Token header as api-key <key>.

Examples

List the first 50 contacts:

operation = get-contacts
apiKey    = <your key>
perPage   = 50

Add a contact to a list (fires its autoresponders):

operation  = create-contact
apiKey     = <your key>
email      = [email protected]
name       = Jane Doe
campaignId = aBcDe

Inspect your autoresponders:

operation = get-autoresponders
apiKey    = <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: get-contacts, create-contact, get-campaigns, get-autoresponders, get-newsletters
`perPage`	string	no	—	get-contacts/get-campaigns/get-autoresponders/get-newsletters: results per page (max 1000, default 100).
`page`	string	no	—	get-contacts/get-campaigns/get-autoresponders/get-newsletters: page number (1-based).
`email`	string	no	—	get-contacts: filter by email (query[email]). create-contact: the contact's email address (required for create-contact).
`campaignId`	string	no	—	get-contacts: filter by campaign/list id (query[campaignId]). create-contact: the campaign (list) id to add the contact to — required for create-contact; adding the contact triggers that list's autoresponders.
`name`	string	no	—	create-contact: the contact's name.
`dayOfCycle`	string	no	—	create-contact: starting day of the autoresponder day-of-cycle for the contact (e.g. 0). Optional.