Mailrelay

The Mailrelay modules allow you to monitor, create, update, send, retrieve, list, and delete the groups and subscribers in your Mailrelay account.

Getting Started with Mailrelay

Prerequisites

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting Mailrelay to Integromat

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

1. Log in to your Mailrelay account.

2. Click Settings > API Keys.

3. Copy the token to your clipboard.

4. Go to Integromat and open the Mailrelay module's Create a connection dialog.

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

6. In the API Key field, enter the token copied in step 3.

7. In the Domain field, enter your organization domain within Mailrelay. For example,  if your account's URL is https://xyz.ipzmarketing.com then the domain is xyz

8. Click Continue.

The connection has been established.

Groups

Search Groups

Searches for groups or lists them all.

ConnectionEstablish a connection to your Mailrelay account.
Search CriteriaSelect or map the search criteria and enter its value to filter the groups that match the specified ID.
LimitSet the maximum number of groups Integromat should return during one execution cycle.

Get a Group

Retrieves a single group specified by ID.

ConnectionEstablish a connection to your Mailrelay account.
Group IDSelect or map the Group ID whose details you want to retrieve.

Create a Group

Creates a new group.

ConnectionEstablish a connection to your Mailrelay account.
NameEnter (map) a name for the group.
DescriptionEnter (map) the details of the group.

Update a Group

Updates a group specified by ID.

ConnectionEstablish a connection to your Mailrelay account.
Group IDSelect or map the Group ID you want to update.
NameEnter (map) a new name for the group.
DescriptionEnter (map) the new details of the group.

Delete a Group

Removes a group specified by ID.

ConnectionEstablish a connection to your Mailrelay account.
Group IDSelect or map the Group ID you want to delete.

Subscribers

Search Subscribers

Searches for subscribers or lists them all.

ConnectionEstablish a connection to your Mailrelay account.
Search CriteriaSelect or map the search criteria and enter its value to filter the groups that match the specified ID.
Include GroupsSelect whether you want to include the groups in the results.
Filter by StatusSelect or map the status to filter the subscribers that match the specified status:
  • Active
  • Inactive
  • Disabled
BannedSelect whether you want to list the banned subscribers.
BouncedSelect whether you want to list the bounced subscribers.
Reported SpamSelect whether you want to list the subscribers that reported spam.
UnsubscribedSelect whether you want to unsubscribed subscribers.
Group IDsSelect or map the Group IDs to list the subscribers that belong to the specified groups.
LimitSet the maximum number of groups Integromat should return during one execution cycle.

Get a Subscribers

Retrieves a subscriber specified by ID.

ConnectionEstablish a connection to your Mailrelay account.
Subscriber IDSelect or map the Subscriber ID whose details you want to retrieve.
Include GroupsSelect whether you want to include subscriber group details in the results.

Create / Update a Subscriber

Creates a new subscriber or updates an existing one.

ConnectionEstablish a connection to your Mailrelay account.
Email Address Select or map the email address of the subscriber whom you want to create or update.
StatusSelect or map the subscriber status:
  • Active
  • Inactive
Replace GroupsSelect whether you want to replace the subscriber group.
Restore if Deleted Select whether you want to restore the subscriber if it is deleted.
NameEnter (map) the subscriber's name.
AddressEnter (map) the subscriber's address.
CityEnter (map) the subscriber's city name.
StateEnter (map) the subscriber's state name.
CountryEnter (map) the subscriber's country name.
BirthdayEnter (map) the subscriber's date of birth.
WebsiteEnter (map) the subscriber's website URL address.
Group IDsSelect or map the Group IDs to which you want to add the subscriber.

Delete a Subscriber

Removes a subscriber specified by ID.

ConnectionEstablish a connection to your Mailrelay account.
Subscriber IDSelect or map the Subscriber ID whose details you want to delete.

Confirmation Emails

Resend a Confirmation Email

Resends a confirmation email to a subscriber specified by ID.

ConnectionEstablish a connection to your Mailrelay account.
Subscriber IDSelect or map the Subscriber ID to whom you want to send the confirmation email.

Other

Make an API Call

Performs an arbitrary authorized API call.

ConnectionEstablish a connection to your Mailrelay account.
URL

Enter a path relative to https://<domain>.ipzmarketing.com/api. For example: /v1/subscribers

For the list of available endpoints, refer to the Mailrelay API Documentation. You must enter your domain name in the URL to access the 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.

HeadersEnter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query StringEnter the request query string.
BodyEnter the body content for your API call.

Example of Use - List Groups

The following API call returns all the groups from your Mailrelay account:

URL:
/v1/groups

Method:
GET

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

Popular use cases from our blog

automated-data-collection-crm-illustration

How to Automate Data Collection - Part 5: CRM Systems

automated-data-collection-chatbot-marketing-illustration

How to Automate Data Collection - Part 4: Chatbot Marketing

automated-data-collection-paid-ads-illustration

How to Automate Data Collection - Part 3: Paid Ads

automated-data-collection-email-illustration

How to Automate Data Collection - Part 2: Email Marketing Segmentation

personalized-customer-experience-illustration-integromat

5 Automated Solutions to Personalize Customer Experience

data-collection-automation-forms-pt-1

How to Automate Data Collection - Part 1: Online Forms

Didn’t find what you were looking for?

Expert

Find an expert

We feature a network of 450+ certified partners across the globe who are ready to help

Find an expert

Automate any workflow in your business

Sign up for a free account today. No credit card required, no time limits on free plan.