GetResponse

Documentation >
Apps >
Communication >
GetResponse

GetResponse¶

With the GetResponse modules in Ibexa Connect, you can:

watch, list, retrieve, create, send, cancel and delete the newsletters
watch, list, retrieve, create, update and delete the contacts
watch, list, retrieve, create, and update the campaigns
list, retrieve, create, update and delete the tags

To get started with the GetResponse, create an account at GetResponse.com.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connect GetResponse with Ibexa Connect¶

To connect the GetResponse app with the Ibexa Connect:

Log in to your Ibexa Connect account, and add a module from the GetResponse app into a Ibexa Connect scenario.
Click Add next to the Connection field.
In the Connection name field, enter a name for the connection and click Save.
If you did not login earlier, enter your GetResponse credentials and click Log in.
Confirm the access by clicking Yes.

You have successfully connected the GetResponse app with Ibexa Connect and can now build scenarios.

Newsletters¶

You can watch, list, retrieve, create, send, cancel and delete the newsletters using the following modules.

Watch Newsletters¶

Triggers when a new newsletter has been created.


Limit	Set the maximum number of newsletters Ibexa Connect will return during one execution cycle. The default value is 2.

List Newsletters¶

Lists all newsletters or searches for them by specified criteria.

Type	Select the type of the newsletter: Draft Broadcast Splittest Automation
Subject	Enter (map) a subject to search newsletters by subject.
Name	Enter (map) a newsletter name to search newsletters by name.
Status	Select the status: Enabled Disabled
Created on (from)	Enter (map) a date to search newsletters created on or after the specified date. See the list of supported date and time formats.
Created on (to)	Enter (map) a date to search newsletters created on or before the specified date. See the list of supported date and time formats.
Campaign ID	Select or map a Campaign ID whose newsletters you want to list.
Sort by Creation Date	Select the order of sorting: Ascending Descending
Limit	Set the maximum number of newsletters Ibexa Connect will return during one execution cycle. The default value is 10.

Returns a specified newsletter.


Newsletter ID	Select or map a Newsletter ID whose details you want to retrieve.

Create a new newsletter and puts it in a queue to send.

Content

Enter (map) the content for the newsletter.

HTML	Enter (map) the message content in HTML format.
Plain	Enter (map) the newsletter text plain text format.

Subject

Enter (map) the subject line for the newsletter.

From Field

Enter (map) the email address from which you will send the newsletter.

Campaign

Select or map a Campaign ID to which you want to assign the newsletter.

The newsletter must be assigned to a campaign.

Send on

Enter (map) the scheduled send date and time for the newsletter in the ISO 8601 format. See the list of supported date and time formats.

Note

To send your message immediately, omit the sendon section.

Attachments

Enter (map) the attachment details. The size of all attachments combined should not exceed 400KB.

File

Enter (map) the file details:

File Name	Enter (map) the file name.
Content	Enter (map) the content in base64 encoded.

Mime Type

Enter (map) the file MIME media type.

Send Settings

Select or map the send settings:

Note

Select the method to deliver the message to the subscriber. You can specify multiple parameters, the system uses AND logic.

Selected Campaigns

Select or map the campaigns to send the newsletter.

At least one of selectedCampaigns, selectedSegments or selectedContacts is required.

Selected Segments

Select or map the segments to send the newsletter.

Note

At least one of selectedCampaigns, selectedSegments or selectedContacts is required.

Selected Contacts

Select or map the contacts to send the newsletter.

Note

At least one of selectedCampaigns, selectedSegments or selectedContacts is required.

Selected Suppressions

Select or map the list of selected suppressions. Note that suppressions exclude contacts.

Excluded Campaigns

Select or map the campaigns to exclude from the newsletter.

Excluded Segments

Select or map the segments to exclude from the newsletter.

Time Travel

Select whether to use the time travel functionality.

Note

The system will match the scheduled sending hour for the message to the time zone of each recipient. As a result, sending may take up to 24 hours.

Perfect Timing

Select whether to use the perfect timing functionality.

External Lexpad

Enter (map) the external lexpad details:


Data Source URL	Enter ( map) a URL to the endpoint that will provide data for External Lexpad.
Data Source Token	Enter (map ) a token that will be sent in X-Auth-Token header to authenticate the requests made to the endpoint.

Reply to

Select or map the email that will be used as the reply-to address.

Flags

Select the message flags:

Openrate
Clicktrack
Google Analytics

Name

Enter (map) a name for the newsletter. Note that it must be between 2 and 128 characters long.

Type

Select the type of the newsletter:

Broadcast
Draft

Editor

Select the editor for the newsletter:

Custom
Text
GetResponse
Legacy
HTML 2

Note

This describes how the content of the message was created.

Sends a newsletter draft.

Newsletter ID	Select the Newsletter ID of a newsletter that you want to send.
Send Settings	Select or map the send settings:	Select how to deliver the message to the subscriber. You can specify multiple parameters, the system uses AND logic.

Selected Campaigns

Select or map the campaigns to send the newsletter.

At least one of selectedCampaigns, selectedSegments or selectedContacts is required.

Selected Segments

Select or map the segments to send the newsletter.

Note

At least one of selectedCampaigns, selectedSegments or selectedContacts is required.

Selected Contacts

Select or map the contacts to send the newsletter.

Note

At least one of selectedCampaigns, selectedSegments or selectedContacts is required.

Selected Suppressions

Select or map the list of selected suppressions. Note that suppressions exclude contacts.

Excluded Campaigns

Select or map the campaigns to be excluded from sending the newsletter.

Excluded Segments

Select or map the segments to be excluded from sending the newsletter.

Time Travel

Select whether to use the time travel functionality.

Note

The system will match the scheduled sending hour for the message to the time zone of each recipient. As a result, sending may take up to 24 hours.

Perfect Timing

Select whether to use the perfect timing functionality.

External Lexpad

Enter (map) the external lexpad details:


Data Source URL	Enter ( map) a URL to the endpoint that will provide data for External Lexpad.
Data Source Token	Enter (map ) a token that will be sent in X-Auth-Token header to authenticate the requests made to the endpoint.

Send on

Enter (map) the scheduled send date for the message in the ISO 8601 format. See the list of supported date and time formats.

Cancels the sending of the newsletter and turns the newsletter into a draft.


Newsletter ID	Select or map a Newsletter ID of a newsletter whose you want to change to draft.

Deletes a specified newsletter.


Newsletter ID	Select or map a Newsletter ID of a newsletter to delete.

Contacts¶

With the contacts module you can watch, list, retrieve, create, update and delete the contacts.

Watch Contacts¶

Triggers when a new contact has been created.


Limit	Set the maximum number of contacts Ibexa Connect should return during one execution cycle. The default value is 2.

List Contacts¶

Lists all contacts or searches for them by specified criteria.

Email	Enter (map) the contact's email address whom you want to search.
Name	Enter (map) the name of the contact you want to search.
Campaign ID	Select or map a Campaign ID of a campaign whose contacts you want to list.
Origin	Select or map an origin to search the contacts.
Created on (from)	Enter (map) a date to count data from this date. See the list of supported date and time formats.
Created on (to)	Enter (map) a date to count data to this date. See the list of supported date and time formats.
Changed on (from)	Enter (map) a date to search contacts edited from this date. See the list of supported date and time formats.
Changed on (to)	Enter (map) a date to search contacts edited to this date. See the list of supported date and time formats.
Sort by Names	Select the order of sorting by names: Ascending Descending
Sort by Email	Select the order of sorting by Email address: Ascending Descending
Sort by Creation Date	Select the order of sorting by date created: Ascending Descending
Sort by Updating Date	Select the order of sorting by date updated: Ascending Descending
Sort by Campaign ID	Select the order of sorting by Campaign ID: Ascending Descending
Limit	Set the maximum number of contacts Ibexa Connect should return during one execution cycle. The default value is 10.

Get a Contact¶

Returns a specified contact.


Contact ID	Select or map the Contact ID of the contact whose details you want to retrieve.

Create a Contact¶

Creates a new contact.

Campaign

Select or map the Campaign ID of a campaign for which you want to create the contact.

Email

Enter (map) the contact's email address. A confirmation message may be sent to the specified address.

Name

Enter (map) a name for the contact.

Day of Cycle

Enter (map) the day on which the contact is in the Autoresponder cycle. Null indicates the contact is not in the cycle.

Scoring

Contact scoring, pass null to remove the score from a contact.

IP Address

Enter (map) the contact's IP address. The formats accepted are IPv4 and IPv6.

Tags

Select or map the tags for the contact to create.

Custom Fields

Enter (map) the custom fields:

Birthdate	Enter (map) the contact's date of birth.
City	Enter (map) the contact's city name.
Comment	Enter (map) the note about the contact.
Company	Select or map the contact's company name.
Country	Enter (map) the contact's country name.
Fax	Enter (map) the contact's fax number.
Gender	Select or map the contact's gender.
Home Phone	Enter (map) the contact's home phone number.
http_referer	Enter (map) the contact's HTTP referer.
Mobile Phone	Enter (map) the contact's mobile phone number.
Phone	Enter (map) the contact's phone number.
Postal Code	Enter (map) the contacts area postal code.
ref	Enter (map) the contact's reference details.
State	Enter (map) the contact's state name.
Street	Enter (map) the contact's residence street name.
URL	Enter (map) the contact's website URL address.
Work Phone	Enter (map) the contact's work phone number.

Update a Contact¶

Updates a specified contact.

Contact ID

Select or map a Contact ID of a contact whose details you want to update.

Campaign

Select or map the Campaign ID of a campaign whose contact details you want to update.

Email

Enter (map) the contact's email address.

Name

Enter (map) an updated name for the contact.

Day of Cycle

Enter (map) the day on which the contact is in the Autoresponder cycle. Null indicates the contact is not in the cycle.

Scoring

Contact scoring, pass null to remove the score from a contact.

IP Address

Enter (map) the contact's IP address. The formats accepted are IPv4 and IPv6.

Tags

Select or map the tags for the contact to create.

Custom Fields

Enter (map) the custom fields:

Birthdate	Enter (map) the contact's date of birth.
City	Enter (map) the contact's city name.
Comment	Enter (map) the note about the contact.
Company	Select or map the contact's company name.
Country	Enter (map) the contact's country name.
Fax	Enter (map) the contact's fax number.
Gender	Select or map the contact's gender.
Home Phone	Enter (map) the contact's home phone number.
http_referer	Enter (map) the contact's HTTP referer.
Mobile Phone	Enter (map) the contact's mobile phone number.
Phone	Enter (map) the contact's phone number.
Postal Code	Enter (map) the contacts area postal code.
Ref	Enter (map) the contact's reference details.
State	Enter (map) the contact's state name.
Street	Enter (map) the contact's residence street name.
URL	Enter (map) the contact's website URL address.
Work Phone	Enter (map) the contact's work phone number.

Delete a Contact¶

Deletes a specified contact.

Contact ID	Select or map the Contact ID of a contact you want to delete.
Message ID	Enter (map) the ID of a message. For example, a newsletter, an autoresponder, or an RSS-newsletter. When passed, this method will simulate the unsubscribe process, as if the contact clicked the unsubscribe link in a given message.
IP Address	Enter (map) an IP address to make it possible to pass the IP from which the contact unsubscribed.	Used only if the `messageId` was sent.

Campaigns¶

With the campaigns module you can watch, list, retrieve, create, and update the campaigns.

Watch Campaigns¶

Triggers when a new campaign has been created.


Limit	Set the maximum number of campaigns Ibexa Connect should return during one execution cycle. The default value is 2.

List Campaigns¶

Lists all campaigns or searches for them by specified criteria.

Name	Enter (map) the name of the campaign you want to search.
Sort by Names	Select the order of sorting by names: Ascending Descending
Is Default	Select whether this is a default campaign.
Sort by Date	Select the order of sorting by creation date: Ascending Descending
Limit	Set the maximum number of campaigns Ibexa Connect should return during one execution cycle. The default value is 10.

Get a Campaign¶

Returns a specified campaign.


Campaign ID	Select or map a Campaign ID of a campaign to retrieve.

Create a Campaign¶

Updates a new campaign.

Name

Enter (map) a name for the campaign.

Confirmation

Enter (map) the confirmation details:

From Field	Select or map the From Field ID.
Redirect Type	Select the type of redirect: Hosted Custom URL	What will happen after email confirmation? The values allowed include: hosted (the subscriber will stay on the default GetResponse website), customUrl (the subscriber will be redirected to a custom URL provided by the user).

Redirect URL

Enter (map) a redirect URL address.

Required if the redirectType is customUrl. The URL a subscriber will be redirected to if the redirectType is set to customUrl.

Mime Type

Select the MIME type for the confirmation message:

Text/HTML
Text/Plain
Combo

Reply to

Select or map the From address ID for the campaign.

Subscription Confirmation Body ID

Select or map the Subscription Confirmation Body ID.

Subscription Confirmation Subject ID

Select or map the Subscription Confirmation Subject ID.

Language Code

Enter (map) the campaign language code according to ISO 639-1. For example, zt - Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian.

Is Default

Select whether the campaign is the default.

Postal

Enter (map) details of the campaign's postal address:


Add Postal to Messages	Select whether to include the postal address in all message footers for this campaign (mandatory for Canada and the US).
City	Enter (map) the city name.
Company Name	Enter (map) the company name.
Country	Enter (map) the country name.
Design	Enter (map) the design the postal address will display in messages.
State	Enter (map) the state name.
Street	Enter (map) the street name.
ZIP Code	Enter (map) the zip code.

Optin Types

Enter (map) the details of optin types:

Note

Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed opt-in enabled.

Email	Select the Email option type: Single Double
API	Select the API option type: Single Double
Import	Select the import option type: Single Double
Webform	Select the webform option type: Single Double

Subscription Notification

Enter (map) the details of the subscription notification:

Status	Select the status of subscription notification: Enabled Disabled
Recipients	Select or map the From address ID.

Profile

Enter (map) the profile details:


Description	Enter (map) a description of a campaign.
Logo	Enter (map) the profile's logo URL address.
Logo Link URL	Enter (map) the profile's logo link URL address.
Title	Enter (map) the profile's title.

Update a Campaign¶

Updates a specified campaign.

Campaign ID

Select or map a Campaign ID of a campaign whose details you want to update.

Name

Enter (map) a name for the campaign.

Confirmation

Enter (map) the confirmation details:

From Field	Select or map the From Field ID.
Redirect Type	Select the type of redirect: Hosted Custom URL	What will happen after email confirmation. The values allowed include: hosted (the subscriber will stay on the default GetResponse website), customUrl (the subscriber will be redirected to a custom URL provided by the user).

Redirect URL

Enter (map) a redirect URL address.

Required if the redirectType is customUrl. The URL a subscriber will be redirected to if the redirectType is set to customUrl.

Mime Type

Select the MIME type for the confirmation message:

Text/HTML
Text/Plain
Combo

Reply to

Select or map the From address ID for the campaign.

Subscription Confirmation Body ID

Select or map the Subscription Confirmation Body ID.

Subscription Confirmation Subject ID

Select or map the Subscription Confirmation Subject ID.

Language Code

Enter (map) the campaign language code according to ISO 639-1. For example, zt - Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian.

Is Default

Select whether the campaign is the default.

Postal

Enter (map) details of the campaign's postal address:


Add Postal to Messages	Select whether to include the postal address in all message footers for this campaign (mandatory for Canada and the US).
City	Enter (map) the city name.
Company Name	Enter (map) the company name.
Country	Enter (map) the country name.
Design	Enter (map) the design the postal address will display in messages.
State	Enter (map) the state name.
Street	Enter (map) the street name.
ZIP Code	Enter (map) the zip code.

Optin Types

Enter (map) the details of optin types:

Note

Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed opt-in enabled.

Email	Select the Email option type: Single Double
API	Select the API option type: Single Double
Import	Select the import option type: Single Double
Webform	Select the webform option type: Single Double

Subscription Notification

Enter (map) the details of the subscription notification:

Status	Select the status of subscription notification: Enabled Disabled
Recipients	Select or map the From address ID.

Profile

Select or map the From address ID.


Description	Enter (map) a description of a campaign.
Logo	Enter (map) the profile's logo URL address.
Logo Link URL	Enter (map) the profile's logo link URL address.
Title	Enter (map) the profile's title.

Tags¶

With the tags module you can List, retrieve, create, update and delete the tags.

Lists all tags or searches for them by specified criteria.

Name	Enter (map) the name of the tag you want to search.
From	Enter (map) a date to search the tags created from this date. See the list of supported date and time formats.
To	Enter (map) a date to search the tags created to this date. See the list of supported date and time formats.
Sort	Select the order to sort the tags by created date: Ascending Descending
Limit	Set the maximum number of tags Ibexa Connect should return during one execution cycle. The default value is 10.

Get a Tag¶

Retrieves a specified tag.


Tag ID	Enter (map) the Tag ID of a tag whose details you want to retrieve.

Create a Tag¶

Creates a new tag.


Name	Enter (map) the tag name. Note that the name must be between 2 and 255 characters long.

Update a Tag¶

Updates a specified tag.


Tag ID	Enter (map) the Tag ID of a tag whose details you want to update.
Name	Enter (map) a new name for the tag.

Delete a Tag¶

Deletes a specified tag.


Tag ID	Enter (map) the Tag ID of a tag to delete.

Other¶

Make an API Call¶

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.getresponse.com. For example, /v3/accounts

For the list of available endpoints, refer to the GetResponse API documentation.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Contacts¶

The following API call will list all the contacts from your GetResponse account:

URL:

/v3/contacts

Method:

GET

Matches of the search can be found in the module's Output under Bundles > Body. In our example, 7 contacts were returned:

GetResponse¶

Connect GetResponse with Ibexa Connect¶

Newsletters¶

Watch Newsletters¶

List Newsletters¶

Get a Newsletter¶

Create a Newsletter¶

Send a Newsletter¶

Cancel a Newsletter Sending¶

Delete a Newsletter¶

Contacts¶

Watch Contacts¶

List Contacts¶

Get a Contact¶

Create a Contact¶

Update a Contact¶

Delete a Contact¶

Campaigns¶

Watch Campaigns¶

List Campaigns¶

Get a Campaign¶

Create a Campaign¶

Update a Campaign¶

Tags¶

List Tags¶

Get a Tag¶

Create a Tag¶

Update a Tag¶

Delete a Tag¶

Other¶

Make an API Call¶

Example of Use - List Contacts¶