GetResponse tools
The 13 GetResponse operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- Search contactsPOSTSearches the contacts of one or more campaigns (contact lists) by subscription status and, optionally, by email or name. Unconfirmed double opt-in contacts show up only here. Page with page and perPage, up to 1000; a page shorter than perPage is the last.
- Get contactGETReturns one active contact with email, name, campaign, dayOfCycle, tags and customFieldValues. A removed contact answers 404.
- Create contactPOSTAdds a contact to a campaign (contact list). GetResponse answers 202 with no body and processes it in a queue that can take a few minutes, so find the contactId later with Search contacts. In a double opt-in list, the person gets a confirmation email first. An email already in the list answers 409.
- Update contactPOSTUpdates a contact. Only the fields sent change. A different campaign moves the contact, with its history and statistics, to that list.
- List campaignsGETLists the campaigns, which are the contact lists of GetResponse, with campaignId, name, languageCode and isDefault. Page with page and perPage, up to 1000; a page shorter than perPage is the last.
- Create campaignPOSTCreates a campaign, which is a contact list in GetResponse, and returns it with its campaignId. An account has up to 1000 lists, and a name already in use answers 409.
- List newslettersGETLists the newsletters, drafts included, with newsletterId, subject, type, campaign, sendOn and sendMetrics, which has delivered, openRate and clickRate. Page with page and perPage, up to 1000; a page shorter than perPage is the last.
- Get newsletterGETReturns one newsletter with its content, fromField, campaign, sendSettings, sendOn and sendMetrics.
- Create newsletterPOSTCreates a newsletter. With type broadcast, the default, it goes into the sending queue right away, or at sendSettings.sendOn; with type draft it is only saved, to send later with Send newsletter draft. GetResponse accepts 256 of these calls a day.
- Send newsletter draftPOSTSends a draft newsletter to the recipients in sendSettings, right away or at sendOn. The draft stops being a draft and goes into the sending queue.
- Get newsletter statisticsGETReturns the statistics of one newsletter as a list of time intervals, each with sent, opens, clicks, forwarded, unsubscribed, bounced and complaints, in total and unique counts. Add the intervals up for the totals; page with page and perPage, and a page shorter than perPage is the last.
- List from fieldsGETLists the sender addresses of the account with fromFieldId, email, name, isActive and isDefault. The fromFieldId goes in fromField and replyTo of Create newsletter. Page with page and perPage.
- List time zonesGETLists the time zones with timezoneId, name, such as America/Sao_Paulo, offset and country. The timezoneId goes in sendSettings.sendOn.timeZone.timeZoneId of Create newsletter and Send newsletter draft.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
