Create contact with the Omnisend API

Creates a contact, or updates the contact that already has the same email identifier. Setting a channel to subscribed sends the welcome message of the brand, when that automation is on, unless sendWelcomeMessage is false.

Identifier
omnisend_create_contact

The request

POST https://connect.reportei.com/api/tools/omnisend_create_contact/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "identifiers": []
  }
}

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
identifiersarrayYesEmail and phone of the contact, each with the subscription status of its channel: email for the email identifier and sms for the phone identifier.
firstNamestringNoFirst name of the contact.
lastNamestringNoLast name of the contact.
tagsarrayNoTags of the contact. Omnisend advises a source tag, such as source: website.
customPropertiesobjectNoCustom properties keyed by name, with Latin letters, digits and underscores only. Values are text, numbers, booleans, dates as text or lists of text; an empty value removes the property.
genderstringNoGender of the contact.Values: m, f
birthdatestringNoBirth date of the contact, as YYYY-MM-DD.
addressstringNoStreet, number and apartment.
citystringNoCity.
statestringNoState as the ISO 3166-2 subdivision code, for example SP.
postalCodestringNoPostal code.
countryCodestringNoCountry as the ISO 3166-1 alpha-2 code, for example BR.

Supported connections

Your customer connects their Omnisend 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/omnisend_create_contact. It becomes your agent's tool definition with no conversion.

Other Omnisend tools

See all 14 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.