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

ParameterTypeRequiredDescription
emailstringYesEmail address of the contact.
campaignobjectYesThe 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.
namestringNoName of the contact.
dayOfCyclestringNoDay of the autoresponder cycle the contact starts on, as text, such as 0. Without it, the contact stays out of the cycle.
scoringnumberNoScore of the contact.
ipAddressstringNoIPv4 or IPv6 address the person subscribed from.
openTrackingConsentbooleanNotrue 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

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.