Create contact with the GetResponse API
Adds 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.
- Identifier
- getresponse_create_contact
The request
POST https://connect.reportei.com/api/tools/getresponse_create_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"email": "<email>",
"campaign": {}
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Email address of the contact. | |
| campaign | object | Yes | The campaign (contact list) of the contact, with campaignId from List campaigns. An email that is in another list becomes a separate contact in this one. |
| name | string | No | Name of the contact. |
| dayOfCycle | string | No | Day of the autoresponder cycle the contact starts on, as text, such as 0. Without it, the contact stays out of the cycle. |
| scoring | number | No | Score of the contact. |
| ipAddress | string | No | IPv4 or IPv6 address the person subscribed from. |
| openTrackingConsent | boolean | No | true when the person agreed to have email opens tracked, false otherwise. |
Supported connections
Your customer connects their GetResponse account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/getresponse_create_contact. It becomes your agent's tool definition with no conversion.
Other GetResponse tools
- 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.
- 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.
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.
