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

# Sequenzy

Sequenzy is an email marketing and automation platform for managing subscribers, campaigns, sequences, transactional email, analytics, and related workspace resources.

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `SEQUENZY`
- **Version:** 00000000_00

## Tools

### Create Tag

**Slug:** `SEQUENZY_CREATE_TAG`

Create a reusable subscriber tag definition; Sequenzy normalizes its name to lowercase and replaces spaces with hyphens.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable tag name; the returned normalized name may differ. |
| `color` | string | No | Optional Sequenzy tag color name, such as blue or emerald. |

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

**Slug:** `SEQUENZY_DELETE_TAG`

Permanently delete a non-system tag definition and remove it from every subscriber. Do not use this on system tags; Sequenzy also rejects tags referenced by sequences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | ID of a non-system tag that is not referenced by a sequence. |

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

**Slug:** `SEQUENZY_GET_EMAIL_METRICS`

Return workspace-wide email delivery and engagement totals and rates for a sliding window or custom range, optionally filtered by email type or mailbox provider. Mailbox-provider filtering reports replies as 0 and omits commerce forecasts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | ISO 8601 end of a custom range; requires start and may span at most 90 days. |
| `start` | string | No | ISO 8601 start of a custom range; requires end and may span at most 90 days. |
| `period` | string ("1h" | "24h" | "7d" | "30d" | "90d") | No | Sliding reporting window; ignored when both start and end are supplied. |
| `email_type` | string ("campaign" | "transactional" | "sequence") | No | Structural email category to include. |
| `mailbox_provider` | string | No | Recipient mailbox provider to include, such as gmail, microsoft, yahoo, or icloud. Provider-filtered results report replies as 0 because replies cannot be segmented by provider and omit commerce forecasts. |
| `include_machine_engagement` | boolean | No | Whether opens and clicks should include detected scanners, previews, and tracked assets. |

#### 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:** `SEQUENZY_GET_SUBSCRIBER`

Retrieve one subscriber by email with list memberships, sequence enrollments, notes, engagement totals, and recent activity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the subscriber to retrieve; path encoding is handled automatically. |
| `include_machine_engagement` | boolean | No | Whether email stats and activity should include detected scanner, preview, and tracked-asset events. |

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

**Slug:** `SEQUENZY_LIST_CAMPAIGNS`

Discover campaigns in the connected workspace, optionally filtered by delivery status or label, without scheduling or sending them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Exact campaign label name to include. |
| `limit` | integer | No | Maximum campaigns to return in this page (1-100). |
| `offset` | integer | No | Zero-based number of campaigns to skip; use next_offset from the prior response to continue. |
| `status` | string ("draft" | "scheduled" | "sent" | "sending" | "cancelled" | "paused" | "waiting_approval" | "rejected") | No | Campaign delivery status to include. |

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

**Slug:** `SEQUENZY_LIST_SEQUENCES`

Discover automation sequences and inspect whether they accept new enrollments or process existing ones, without activating or enrolling anyone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum sequences to return in this page (1-100). |
| `labels` | array | No | Dashboard label names used to filter sequences. |
| `offset` | integer | No | Zero-based number of sequences to skip; use next_offset from the prior response to continue. |
| `search` | string | No | Case-insensitive text to match against sequence name or description. |
| `status` | string ("draft" | "active" | "paused" | "archived") | No | Sequence lifecycle status to include. |

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

**Slug:** `SEQUENZY_LIST_SUBSCRIBER_LISTS`

Return the reusable subscriber lists available for audience filtering and membership workflows.

#### 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:** `SEQUENZY_LIST_SUBSCRIBERS`

Search and filter subscribers in the connected workspace, returning one stable cursor page for audience review or export.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum subscribers to return in this page (1-1000). |
| `query` | string | No | Free-text search across email, first name, last name, and tags. |
| `status` | string ("active" | "unsubscribed" | "bounced" | "all") | No | Subscriber status to include; use all to disable status filtering. |
| `list_id` | string | No | Return only subscribers belonging to this subscriber list ID. |
| `tag_names` | array | No | Tag names the subscriber must have; all supplied tags must match. |
| `segment_id` | string | No | Return only subscribers in this saved segment ID. |
| `next_cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |

#### 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:** `SEQUENZY_LIST_TAGS`

Return reusable subscriber tag definitions, including which tags are protected system 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 |

### List Templates

**Slug:** `SEQUENZY_LIST_TEMPLATES`

Discover reusable email templates and campaign-backed email bodies by label, returning one page with localization metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Exact template label name to include. |
| `limit` | integer | No | Maximum templates to return in this page (1-100). |
| `offset` | integer | No | Zero-based number of templates to skip; use next_offset from the prior response to continue. |

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