• Documentation >
• Apps >
• Marketing >
• Mailvio

Mailvio

The Mailvio modules allow you to watch, create, update, list, retrieve, and delete the contacts, and contact attributes in your Mailvio account.

Getting Started with Mailvio

Prerequisites

• A Mailvio account

In order to use Mailvio with Ibexa Connect, it is necessary to have a Mailvio account. If you do not have one, you can create a Mailvio account at app.mailvio.com.

Note

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

Connecting Mailvio to Ibexa Connect

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

1. Log in to your Mailvio account.

2. From your Dashboard, click API Details.

   

3. Copy the API Key to your clipboard.

   

4. Go to Ibexa Connect and open the Mailvio 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 API Key copied in step 3 and click Continue.

The connection has been established.

Contacts

Watch New Contacts

Triggers when a new contact has been added.

Limit	Set the maximum number of contacts Ibexa Connect should return during one scenario execution cycle.

List Contacts

Lists all contacts.

Modified Since	Enter the date to list the contacts changed on or after the specified date. See the list of supported formats.
Limit	Set the maximum number of contacts Ibexa Connect should return during one scenario execution cycle.

Get a Contact

Get a contact's information by the contact's email or SMS number.

Search Criteria	Select the option to choose the criteria for selecting the contact whose details you want to retrieve: By Email By SMS Attribute
Email	Select (map) the email address of the contact whose detail you want to retrieve.
SMS Attribute	Enter the SMS phone number details of the contact whose details you want to retrieve.

Create a Contact

Creates a new contact.

Email	Enter the contact's email address.
Attributes	Enter the contact's attribute details. You must have created the attributes in your account.
Email Blacklisted	Select whether to blacklist the contact's email address from emails.
SMS Blacklisted	Select whether to blacklist the contact's email address from SMS.
List IDs	Select the List ID in which you want to include the contact.
Update Enabled	Select whether to update the contact when a request to modify the details is received.
SMTP Blacklist Senders	Add the sender details from which the contact's email address must be blacklisted.

Update a Contact

Updates contact.

Email	Enter the contact's email address.
Attributes	Enter the details of the attributes applicable to the contact.
Email Blacklisted	Select whether to blacklist the contact's email address from emails.
SMS Blacklisted	Select whether to blacklist the contact's email address from SMS.
List IDs	Select the List ID in which you want to include the contact.
List IDs to Unlink	Select the List ID from which you want to remove the contact.
Update Enabled	Select whether to update the contact when a request to modify the details is received.
SMTP Blacklist Senders	Add the sender details from which the contact's email address must be blacklist the

Delete a Contact

Deletes a contact.

Email	Select the email address of the contact you want to delete.

Add Contacts to a List

Adds one or more contacts to a list specified by ID.

List ID	Select the List ID to which you want to add the contacts.
Emails	Select the email addresses of the contacts whom you want to add to the list.

Remove Contacts from a List

Removes one or more contacts from a list specified by ID.

List ID	Select the List ID from which you want to remove the contacts.
Emails	Select the email addresses of the contacts whom you want to remove from the list.

Contacts Attributes

List Contacts Attributes

Lists all attributes available for the contacts.

Limit	Set the maximum number of contact attributes Ibexa Connect should return during one scenario execution cycle.

Create a Contact Attribute

Creates a new attribute to be used for contacts.

Attribute Name	Select the name of the attribute you want to create. For example, Firstname.
Attribute Category	Select the attribute's category. For example, global.
Type	Select the attribute type: Text Date Float Boolean

Update a Contact Attribute

Updates an existing attribute of category, calculated or global type.

Attribute Name	Select the name of the attribute whose details you want to update. For example, Blacklist. The attributes must have created in your account.
Attribute Category	Select the attribute's category. For example, global.
Value	Enter the value of the attribute. The value should be a formula for the attribute.

Delete a Contact's Attribute

Deletes a contact's attribute.

Attribute Name	Select the name of the attribute you want to delete.
Attribute Category	Select the attribute's category. For example, global.
Value	Enter the value of the attribute. The value should be a formula for the attribute.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

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

For the list of available endpoints, refer to the MailVio 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.

Example of Use - List Tasks

The following API call returns all the contact lists from your Mailvio account:

URL:

/v3/contacts/lists

Method:

GET

Matches of the search can be found in the module's Output under Bundle > Body > lists.

In our example, 10 contact lists were returned: