• Documentation >
• Apps >
• Marketing >
• Automizy

Automizy

The Automizy modules allow you to create, update, list, and delete the contacts and lists in your Automizy account.

Getting Started with Automizy

Prerequisites

• An Automizy account

In order to use Automizy with Ibexa Connect, it is necessary to have an Automizy account. You can create an Automizy account at automizy.com/register.

Note

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

Connecting Automizy to Ibexa Connect

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

1. Login to your Automizy account.

2. Click Settings > API Token > Create Token.

   

3. Copy the API Token to your clipboard.

   

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

The connection has been established.

List

List All Lists

Retrieves lists of all lists.

Limit	Enter the maximum number of lists Ibexa Connect should return during one scenario execution cycle.
Fields	Enter the field names in the lists which you want to list.
Order	Enter the order in which you want to list the lists. For example, Asc or desc.

Get a List

Retrieves an existing list by ID.

List	Select the list whose details you want to retrieve.

Create a List

Creates a new list.

Name	Enter a name for the list.

Update a List

Updates an existing list by ID.

List	Select the list you want to update.
Name	Enter a new name for the list.

Delete a List

Deletes an existing list by ID.

List	Select the list you want to delete.

Contact

Watch New Contacts

Triggers when a new contact is created.

List	Select the list whose new contacts you want to watch.
Limit	Enter the maximum number of contacts Ibexa Connect should return during one scenario execution cycle.

List Contacts

Retrieves all contacts from the selected list.

List	Select the list whose new contacts you want to list.
Limit	Enter the maximum number of contacts Ibexa Connect should return during one scenario execution cycle.

Get a Contact

Retrieves an existing contact by email.

Email Address	Enter the email address of the contact whose details you want to retrieve.

Create a Contact

Creates a new contact for the selected list.

List	Select the list in which you want to create the contact.
Email Address	Enter the email address of the contact.
Status	Select the status of the contact: Active Bounced Banned Unsubscribed
Tags	Add the tags to filter the contacts when searching.
Company	Enter the company name to which the contact belongs to.
First Name	Enter the first name of the contact.
Last Name	Enter the last name of the contact.
Phone	Enter the phone number of the contact.
Position	Enter the contact's position in the company.
Website	Enter the website address of the contact or the company.

Update a Contact

Updates an existing contact.

Contact ID	Enter (map) the Contact ID whose details you want to update.
Email Address	Enter a new email address for the contact.
List	Select the list in which you want to create the contact.
Status	Select the status of the contact: Active Bounced Banned Unsubscribed
Tags	Set the tags to filter the contacts when searching.
Add Tags	Add the new tags to filter the contact when searching.
Remove Tags	Add the tags which you want to remove from the contact details.

Delete a Contact

Deletes an existing contact by email.

Email Address	Enter the new email address of the contact.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://gateway.automizy.com/. For example: v2/smart-lists

For the list of available endpoints, refer to the Automizy 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 - Get All Lists

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

URL:

v2/smart-lists

Method:

GET

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

In our example, 2 lists were returned: