---
title: Automizy
slug: automizy
image: https://make-cxp-documentation.ams3.digitaloceanspaces.com/apps-center-icons/PREVIEW_automizy.png
createdAt: 2025-02-03T13:29:04.395Z
---

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

# Get Started with Automizy

Prerequisites

- An Automizy account

In order to use Automizy with Make, it is necessary to have an Automizy account. You can create an Automizy account at [automizy.com/register](https://automizy.com/register/).

# Connect Automizy to Make

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

1. Login to your Automizy account.
2. Click *Settings* > *API Token* > *Create Token*.

   ![](https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/DFTau-xiAfdxqpOGk2JdC_uuid-4ac457b9-156e-0e5c-0add-d9cb4d6a41cf.gif)
3. Copy the API Token to your clipboard.

   ::Image[]{src="https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/ySEegOUIYDcAr2UVRmE2__uuid-da2564cd-0b5c-27eb-a16c-039a493ec1ce.png" size="50" width="598" height="266" position="flex-start" showCaption="false"}
4. Go to **Make** and open the Automizy module's *Create a connection* dialog.

   ![](https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/kzBU5GSWCv8lah0BwZrW9_uuid-c63b9fcf-b8b1-d865-10ae-9f1c4600d5c6.gif)
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.

# Automizy modules

## List

### List All Lists

Retrieves lists of all lists.

| **Field**      | **Description**                                                                       |
| -------------- | ------------------------------------------------------------------------------------- |
| **Connection** | Establish a connection to your Automizy account.                                      |
| **Limit**      | Enter the maximum number of lists Make should return during one Make 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.

| **Field**      | **Description**                                     |
| -------------- | --------------------------------------------------- |
| **Connection** | Establish a connection to your Automizy account.    |
| **List**       | Select the list whose details you want to retrieve. |

### Create a List

Creates a new list.

| **Field**      | **Description**                                  |
| -------------- | ------------------------------------------------ |
| **Connection** | Establish a connection to your Automizy account. |
| **Name**       | Enter a name for the list.                       |

### Update a List

Updates an existing list by ID.

| **Field**      | **Description**                                  |
| -------------- | ------------------------------------------------ |
| **Connection** | Establish a connection to your Automizy account. |
| **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.

| **Field**      | **Description**                                  |
| -------------- | ------------------------------------------------ |
| **Connection** | Establish a connection to your Automizy account. |
| **List**       | Select the list you want to delete.              |

## Contact

### Watch New Contacts

Triggers when a new contact is created.

| **Field**      | **Description**                                                                          |
| -------------- | ---------------------------------------------------------------------------------------- |
| **Connection** | Establish a connection to your Automizy account.                                         |
| **List**       | Select the list whose new contacts you want to watch.                                    |
| **Limit**      | Enter the maximum number of contacts Make should return during one Make execution cycle. |

### List Contacts

Retrieves all contacts from the selected list.

| **Field**      | **Description**                                                                          |
| -------------- | ---------------------------------------------------------------------------------------- |
| **Connection** | Establish a connection to your Automizy account.                                         |
| **List**       | Select the list whose new contacts you want to list.                                     |
| **Limit**      | Enter the maximum number of contacts Make should return during one Make execution cycle. |

### Get a Contact

Retrieves an existing contact by email.

| **Field**         | **Description**                                                            |
| ----------------- | -------------------------------------------------------------------------- |
| **Connection**    | Establish a connection to your Automizy account.                           |
| **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.

| **Field**         | **Description**                                                                                  |
| ----------------- | ------------------------------------------------------------------------------------------------ |
| **Connection**    | Establish a connection to your Automizy account.                                                 |
| **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:<br />- Active<br />- Bounced<br />- Banned<br />- 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.

| **Field**         | **Description**                                                                                  |
| ----------------- | ------------------------------------------------------------------------------------------------ |
| **Connection**    | Establish a connection to your Automizy account.                                                 |
| **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:<br />- Active<br />- Bounced<br />- Banned<br />- 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.

| **Field**         | **Description**                                       |
| ----------------- | ----------------------------------------------------- |
| **Connection**    | [Establish a connection to your Automizy account](#). |
| **Email Address** | Enter the new email address of the contact.           |

## Other

### [Make an API Call](#)

Performs an arbitrary authorized API call.

| **Field**        | **Description**                                                                                                                                                                                                                                             |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Connection**   | [Establish a connection to your Automizy account](#).                                                                                                                                                                                                       |
| **URL**          | Enter a path relative to `https://gateway.automizy.com/`. For example: `v2/smart-lists`                                                                                                                                                                     |
| **Method**       | Select the HTTP method you want to use:<br /><br />GET: to retrieve information for an entry.<br />POST: to create a new entry.<br />PUT: to update/replace an existing entry.<br />PATCH: to make a partial entry update.<br />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`

::Image[]{src="https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/qY4-CBEwyFsAwwI5Bqd6w_uuid-2e3c1c59-036d-600c-fd90-d22e059f016d.png" size="60" width="299" height="638" position="flex-start" showCaption="false"}

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

In our example, 2 lists were returned:

::Image[]{src="https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/EMg2kHHpVtDVSSwf49lIA_uuid-07b9b3ba-0978-ec38-c053-293bfd581c33.png" size="50" width="295" height="425" position="flex-start" showCaption="false"}

For the list of available endpoints, refer to the [Automizy API Documentation](https://developers.automizy.com/automizyrestapi/).
