Omnisend

The Omnisend modules allow you to search, list, retrieve, create, update, and delete the contacts, and events in your Omnisend account.

Getting Started with Omnisend

Prerequisites

  • An Omnisend account

In order to use Omnisend with Make, it is necessary to have an Omnisend account. If you do not have one, you can create an Omnisend account at omnisend.com.

Connecting Omnisend to Make

To connect your Omnisend account to Make you need to obtain the API Key from your Omnisend account and insert it in the Create a connection dialog in the Make module.

1. Log in to your Omnisend account.

2. Click Your Profile Icon > Store Settings > Integrations & API > API Keys > Create API Key.

61f274893fb0d.gif

3. Enter the name for the API Key, select the permissions, and click Save.

61f2748bc26ea.png

4. Copy the API Key to your clipboard.

61f2748ce71f2.png

5. Go to Make and open the Omnisend module's Create a connection dialog.

61f2748dcb419.gif

6. In the Connection name field, enter a name for the connection.

7. In the API Key field, enter the API key copied in step 4, and click Continue.

The connection has been established.

Events

Triggers a custom event in Omnisend.

Connection

Establish a connection to your Omnisend account.

Event ID

Select the Event ID you want to watch.

Email

Enter the email address of the contact whose events you want to watch.

Phone

Enter the contact's phone number whose events you want to watch.

Retrieves information about a custom event.

Connection

Establish a connection to your Omnisend account.

Event ID

Select the Event ID whose details you want to retrieve.

Returns a list of custom events.

Connection

Establish a connection to your Omnisend account.

Limit

Set the maximum number of events Make should return during one scenario execution cycle.

Creates a custom event.

Connection

Establish a connection to your Omnisend account.

Name

Enter the event name.

System Name

Enter the event name in the system.

Email

Enter the contact email address for the event. You must mention either an email address or a phone number to create the event.

Phone

Enter the contact phone number for the event. You must mention either an email address or a phone number to create the event.

Custom Properties

Add the custom properties for the event:

Name

Enter the custom property name. For example, company.

Type

Select the value type. For example, text.

Value

Enter the custom property value. For example, company name.

Contacts

Creates or updates a subscriber with all provided values, i.e. name, phone number, tag, etc.

Connection

Establish a connection to your Omnisend account.

First Name

Enter the contact's first name.

Last Name

Enter the contact's last name.

Tags

Add the tags for the contact separated by a comma.

Identifiers

Add the identifiers for the contact:

Type

Select the identifier type:

  • Email

  • Phone

Channel Status

Select whether the contact's email address or phone number is subscribed.

Status Date

Enter the date when the email address or phone status of the contact last checked.

Email

Enter the contact's email address.

Phone Number

Enter the contact's phone number.

Source

Enter the source details from where you have received the contact information. For example, webinar.

Send Welcome Message

Select the checkbox to send a welcome email or SMS to the contact.

Searches for contacts.

Connection

Establish a connection to your Omnisend account.

Limit

Set the maximum number of contacts Make should return during one scenario execution cycle.

Email address

Enter the contact's email address whose details you want to search.

Status

Select the status to search the contacts with the specified status. For example, subscribed.

Segment ID

Enter the Segment ID to search the contacts with the specified segment.

Phone

Enter the phone number to search the contacts with the specified number.

Updates a contact module.

Connection

Establish a connection to your Omnisend account.

Contact ID

Select the Contact ID whose details you want to update.

First Name

Enter the contact's first name.

Last Name

Enter the contact's first name.

Tags

Add the tags for the contact separated by a comma.

Identifiers

Add the identifiers for the contact:

Type

Select the identifier type:

  • Email

  • Phone

Channel Status

Select whether the contact's email address or phone number is subscribed.

Status Date

Enter the date when the email address or phone status of the contact last checked.

Email

Enter the contact's email address.

Phone Number

Enter the contact's phone number.

Source

Enter the source details from where you have received the contact information. For example, webinar.

Send Welcome Message

Select the checkbox to send a welcome email or SMS to the contact.

Retrieves information about a specific contact.

Connection

Establish a connection to your Omnisend account.

Contact ID

Select the Contact ID whose details you want to retrieve.

Other

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Omnisend account.

URL

Enter a path relative to https://api.omnisend.com/. For example: /v3/contacts

Note

For the list of available endpoints, refer to the Omnisend API Documentation.

Method

Select the HTTP method you want to use:

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.

The following API call returns all the events from your Omnisend account:

URL: /v3/events

Method: GET

61f2748fe2e9f.png

Matches of the search can be found in the module's Output under Bundle > Body. In our example, 3 events were returned:

61f27490e0652.png