# Mailercloud

Powerful and simple all-in-one email marketing platform providing effective solutions for rapid business growth.

- **Category:** email newsletters
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `MAILERCLOUD`
- **Version:** 00000000_00

## Tools

### Create List

**Slug:** `MAILERCLOUD_CREATE_LIST`

Tool to create a new recipient list in Mailercloud for storing and managing contacts. Use when you need to create a new mailing list for organizing contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the list to create. This is the display name that will be used to identify the list. |
| `list_type` | integer | Yes | Type of list to create. Use 1 for Subscription List. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create custom property

**Slug:** `MAILERCLOUD_CREATE_PROPERTY`

Create a custom property for contacts in Mailercloud. Custom properties store specific information for contact records. Maximum of 100 properties allowed per account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the custom property to create. This will be used to identify the property when storing contact information. |
| `type` | string | Yes | Type of the custom property. Defines the kind of data that can be stored in this property. Common types include 'text' for string values, 'number' for numeric values, and 'date' for date values. |
| `description` | string | No | Optional description of the custom property. Helps document the purpose and usage of the property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact Property

**Slug:** `MAILERCLOUD_DELETE_PROPERTY`

Tool to delete a custom contact property by ID. Use when removing unused custom fields from contacts. Cannot delete properties used in webforms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `property_id` | string | Yes | Unique identifier of the custom property to delete. WARNING: You cannot delete a property if it is used in a webform. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Client Plan

**Slug:** `MAILERCLOUD_GET_CLIENT_PLAN`

Tool to retrieve client plan information from Mailercloud. Use when you need to check the current subscription status, plan details, or verify API connectivity.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Contacts in List

**Slug:** `MAILERCLOUD_SEARCH_CONTACTS`

Tool to retrieve contacts in a specific list with pagination. Use when you need to list or search contacts within a known list ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | Yes | Page number for pagination (must be at least 1) |
| `limit` | integer | Yes | Number of records per page (1-100) |
| `list_id` | string | Yes | ID of the list to search contacts in |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact Property

**Slug:** `MAILERCLOUD_UPDATE_PROPERTY`

Tool to update a custom property of contacts in Mailercloud. Use when you need to modify the name or description of an existing custom property. Note: Editing custom property type using this API is not possible - you can only edit the name and description.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the custom property. If not provided, the current name will be retained. |
| `description` | string | No | New description for the custom property. If not provided, the current description will be retained. |
| `property_id` | string | Yes | The ID of the property to update. Use MAILERCLOUD_LIST_PROPERTY to find available property IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |