---
canonical_url: "https://docs.composio.dev/toolkits/maildroppa"
markdown_url: "https://docs.composio.dev/toolkits/maildroppa.md"
product: "platform"
version: null
last_updated: null
---

# Maildroppa

Maildroppa is an email marketing platform for managing subscribers, segmentation, newsletters, transactional email, events, and webhooks.

- **Category:** email newsletters
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 23
- **Triggers:** 0
- **Slug:** `MAILDROPPA`
- **Version:** 00000000_00

## Tools

### Archive Tag

**Slug:** `MAILDROPPA_ARCHIVE_TAG`

Archive one customer-managed tag. Archiving prevents new assignments but preserves existing subscriber assignments and can be reversed by restoring the tag. Use the tag-usage tool first to inspect archive blockers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Unique identifier of the customer-managed tag to archive. |

#### 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 |

### Count Segment Subscribers

**Slug:** `MAILDROPPA_COUNT_SEGMENT_SUBSCRIBERS`

Return the current number of subscribers matching one stored segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Unique identifier of the segment whose matching subscribers to count. |

#### 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 Segment

**Slug:** `MAILDROPPA_CREATE_SEGMENT`

Create a subscriber segment from field, tag, or nested-segment conditions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Segment name shown in Maildroppa. |
| `condition_groups` | array | Yes | Non-empty filter groups. Conditions in one group are ANDed and groups are ORed. |

#### 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 Subscriber

**Slug:** `MAILDROPPA_CREATE_SUBSCRIBER`

Create a subscriber without sending an opt-in message, with optional typed field values and tag assignments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Subscriber email address. |
| `fields` | array | No | Custom field values with a field ID and matching typed value payload. |
| `tag_ids` | array | No | Existing tag IDs to assign to the subscriber. |
| `first_name` | string | No | Subscriber first name. |
| `subscriber_status` | string ("PENDING" | "CONFIRMED" | "UNSUBSCRIBED" | "COLD" | "BOUNCED" | "SOFT_BOUNCED" | "BLOCKED" | "DELETED") | No | Initial subscriber status. Use PENDING only when intended; this action does not send a confirmation email. |

#### 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 Subscribers

**Slug:** `MAILDROPPA_CREATE_SUBSCRIBERS`

Sequentially create 1-25 subscribers without sending opt-in messages. The batch is non-atomic, returns an outcome for every item, and stops after a systemic or ambiguous failure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscribers` | array | Yes | Subscribers to create sequentially in request order (1-25). The batch is non-atomic: successful creations remain if a later item fails. |

#### 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 Tag

**Slug:** `MAILDROPPA_CREATE_TAG`

Create a customer-managed tag that can be assigned to subscribers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tag name shown in Maildroppa. |

#### 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 Segment

**Slug:** `MAILDROPPA_DELETE_SEGMENT`

Permanently delete exactly one stored subscriber segment identified by an explicit segment ID. This action cannot select segments by filter or bulk criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Exact ID of the single stored segment to permanently delete. Obtain and verify this ID before calling; filters and bulk selection are not accepted. |

#### 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 Subscriber

**Slug:** `MAILDROPPA_DELETE_SUBSCRIBER`

Permanently delete exactly one subscriber identified by an explicit subscriber ID. This action cannot select subscribers by email, filter, or bulk criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscriber_id` | string | Yes | Exact ID of the single subscriber to permanently delete. Obtain and verify this ID before calling; email addresses and bulk selection are not accepted. |

#### 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 Form Embedding

**Slug:** `MAILDROPPA_GET_FORM_EMBEDDING`

Return an active Maildroppa form's ordered input-field definition for rendering in a trusted website integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form_id` | string | Yes | Unique identifier of the active form, obtainable from List Forms. |

#### 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 Segment

**Slug:** `MAILDROPPA_GET_SEGMENT`

Return one stored subscriber segment and its complete filter expression by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Unique identifier of the segment. |

#### 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 Subscriber

**Slug:** `MAILDROPPA_GET_SUBSCRIBER`

Return one Maildroppa subscriber by ID, including display field values, tag IDs, status, registration date, and GDPR agreement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscriber_id` | string | Yes | Unique identifier of the subscriber. |

#### 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 Tag Usage

**Slug:** `MAILDROPPA_GET_TAG_USAGE`

Return subscriber assignments and archive or permanent-delete blockers for one Maildroppa tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Unique identifier of the tag whose current usage to inspect. |

#### 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 |

### List Forms

**Slug:** `MAILDROPPA_LIST_FORMS`

Return signup form overviews with IDs, type, status, publication state, and public routing details.

#### 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 |

### List RSS Newsletters

**Slug:** `MAILDROPPA_LIST_RSS_NEWSLETTERS`

Return the account's RSS newsletter configurations without activating, checking, or sending them.

#### 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 |

### List RSS Sender Profiles

**Slug:** `MAILDROPPA_LIST_RSS_SENDER_PROFILES`

Return sender profiles available to RSS newsletters, including verification and delivery readiness.

#### 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 |

### List Segments

**Slug:** `MAILDROPPA_LIST_SEGMENTS`

Return the account's stored subscriber segments and filter expressions.

#### 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 |

### List Subscriber Activity

**Slug:** `MAILDROPPA_LIST_SUBSCRIBER_ACTIVITY`

Return one page of a subscriber's activity timeline with delivery eligibility and summary counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum activity entries to return in this page. |
| `cursor` | string | No | Continuation cursor returned by a previous activity call. Omit for the first page. |
| `subscriber_id` | string | Yes | Unique identifier of the subscriber whose activity to return. |

#### 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 |

### List Subscriber Fields

**Slug:** `MAILDROPPA_LIST_SUBSCRIBER_FIELDS`

Return built-in and custom subscriber field definitions, optionally including archived custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_archived` | boolean | No | Whether to include archived custom fields along with active and built-in fields. |

#### 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 |

### List Subscribers

**Slug:** `MAILDROPPA_LIST_SUBSCRIBERS`

Return one page of subscribers, optionally filtered by free text, status, or structured segment conditions. Pass next_cursor back as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Free-text subscriber search. Cannot be combined with condition_groups. |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call. The cursor retains the original route and filters. |
| `status` | string ("PENDING" | "CONFIRMED" | "UNSUBSCRIBED" | "COLD" | "BOUNCED" | "SOFT_BOUNCED" | "BLOCKED" | "DELETED") | No | Return only subscribers with this status. |
| `page_size` | integer | No | Maximum subscribers to return in this page. |
| `condition_groups` | array | No | Structured filters. Conditions in one group are ANDed and groups are ORed. Cannot be combined with query. |

#### 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 |

### List Tags

**Slug:** `MAILDROPPA_LIST_TAGS`

Return account tags, optionally including archived tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_archived` | boolean | No | Whether to include archived tags in addition to active tags. |

#### 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 |

### Restore Tag

**Slug:** `MAILDROPPA_RESTORE_TAG`

Restore an archived customer-managed Maildroppa tag so it can be assigned to subscribers again.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Unique identifier of the archived customer-managed tag to restore. |

#### 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 Segment

**Slug:** `MAILDROPPA_UPDATE_SEGMENT`

Replace a segment's name and complete filter expression. This is a full replacement, so supply every condition group that should remain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Replacement segment name. |
| `segment_id` | string | Yes | Unique identifier of the segment to update. |
| `condition_groups` | array | Yes | Complete replacement filter groups. Conditions in one group are ANDed and groups are ORed; omitted existing groups are removed. |

#### 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 Tag

**Slug:** `MAILDROPPA_UPDATE_TAG`

Rename an existing customer-managed tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New tag name shown in Maildroppa. |
| `tag_id` | string | Yes | Unique identifier of the customer-managed tag to rename. |

#### 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 |