| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
The Mailvio modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. allow you to watch, create, update, list, retrieve, and delete the contacts and contact attributes in your Mailvio account.
Prerequisites
-
A Mailvio account
In order to use Mailvio with Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., create an account at app.mailvio.com.
To connect your Mailvio account to Boost.space Integrator you need to obtain the API Key from your Mailvio account and insert it in the Create a connection dialog in the Boost.space Integrator modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve..
-
Log in to your Mailvio account.
-
From your Dashboard, click API Details.
-
Copy the API Key to your clipboard.
-
Go to Boost.space Integrator and open the Mailvio module’s Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the API Key copied in step 3 and click Continue.
The connection has been established.
TriggersThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when a new contact has been added.
|
Connection |
|
|
Limit |
Set the maximum number of contacts Boost.space Integrator should return during one scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Lists all contacts.
|
Connection |
|
|
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 Boost.space Integrator should return during one scenario execution cycle. |
Get a contact’s information by the contact’s email or SMS number.
|
Connection |
|
|
Search Criteria |
Select the option to choose the criteria for selecting the contact whose details you want to retrieve:
|
|
|
Select (map) the contact’s email address whose detail you want to retrieve. |
|
SMS Attribute |
Enter the SMS phone number details of the contact whose details you want to retrieve. |
Creates a new contact.
|
Connection |
|
|
|
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. |
Updates contact.
|
Connection |
|
|
|
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 blacklisted. |
Deletes a contact.
|
Connection |
|
|
|
Select the email address of the contact you want to delete. |
Adds one or more contacts to a list specified by ID.
|
Connection |
|
|
List ID |
Select the List ID to which you want to add the contacts. |
|
Emails |
Select the email addresses of the contacts you want to add to the list. |
Removes one or more contacts from a list specified by ID.
|
Connection |
|
|
List ID |
Select the List ID from which you want to remove the contacts. |
|
Emails |
Select the email addresses of the contacts you want to remove from the list. |
Lists all attributes available for the contacts.
|
Connection |
|
|
Limit |
Set the maximum number of contact attributes Boost.space Integrator should return during one scenario execution cycle. |
Creates a new attribute to be used for contacts.
|
Connection |
|
|
Attribute Name |
Select the name of the attribute you want to create. For example, |
|
Attribute Category |
Select the attribute’s category. For example, |
|
Type |
Select the attribute type:
|
Updates an existing attribute of category, calculated or global type.
|
Connection |
|
|
Attribute Name |
Select the name of the attribute whose details you want to update. For example, The attributes must have been created in your account. |
|
Attribute Category |
Select the attribute’s category. For example, |
|
Value |
Enter the value of the attribute. The value should be a formula for the attribute. |
Deletes a contact’s attribute.
|
Connection |
|
|
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. |
Performs an arbitrary authorized API call.
|
Connection |
||||
|
URL |
Enter a path relative to
|
|||
|
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. |
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png)
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 BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body > lists.
In our example, 10 contact lists were returned:
