> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# mailerlite
> MailerLite Email Marketing
**Server path:** `/mailerlite` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| [`mailerlite_assign_subscribers_groups`](#mailerlite_assign_subscribers_groups) | Assign subscriber to a group |
| [`mailerlite_cancel_campaigns_cancel`](#mailerlite_cancel_campaigns_cancel) | Cancel a ready campaign |
| [`mailerlite_create_campaigns`](#mailerlite_create_campaigns) | Create a campaign |
| [`mailerlite_create_fields`](#mailerlite_create_fields) | Create a field |
| [`mailerlite_create_groups`](#mailerlite_create_groups) | Create a group |
| [`mailerlite_create_subscribers`](#mailerlite_create_subscribers) | Create/upsert subscriber |
| [`mailerlite_create_webhooks`](#mailerlite_create_webhooks) | Create a webhook |
| [`mailerlite_delete_campaigns`](#mailerlite_delete_campaigns) | Delete a campaign |
| [`mailerlite_delete_fields`](#mailerlite_delete_fields) | Delete a field |
| [`mailerlite_delete_forms`](#mailerlite_delete_forms) | Delete a form |
| [`mailerlite_delete_groups`](#mailerlite_delete_groups) | Delete group |
| [`mailerlite_delete_segments`](#mailerlite_delete_segments) | Delete segment |
| [`mailerlite_delete_subscribers`](#mailerlite_delete_subscribers) | Delete a subscriber |
| [`mailerlite_delete_webhooks`](#mailerlite_delete_webhooks) | Delete a webhook |
| [`mailerlite_get_automations`](#mailerlite_get_automations) | Get an automation |
| [`mailerlite_get_automations_activity`](#mailerlite_get_automations_activity) | Get the subscriber activity for an automation |
| [`mailerlite_get_campaigns`](#mailerlite_get_campaigns) | Get a campaign |
| [`mailerlite_get_campaigns_reports_subscriber_activity`](#mailerlite_get_campaigns_reports_subscriber_activity) | Get subscribers' activity of a sent campaign |
| [`mailerlite_get_forms`](#mailerlite_get_forms) | Get a form |
| [`mailerlite_get_forms_popup`](#mailerlite_get_forms_popup) | List all forms |
| [`mailerlite_get_subscribers`](#mailerlite_get_subscribers) | Fetch a subscriber |
| [`mailerlite_get_subscribers_import`](#mailerlite_get_subscribers_import) | Get single import |
| [`mailerlite_get_subscribers_stats`](#mailerlite_get_subscribers_stats) | Get subscriber statistics |
| [`mailerlite_get_webhooks`](#mailerlite_get_webhooks) | Get a webhook |
| [`mailerlite_list_automations`](#mailerlite_list_automations) | List all automations |
| [`mailerlite_list_campaigns`](#mailerlite_list_campaigns) | Campaigns list |
| [`mailerlite_list_fields`](#mailerlite_list_fields) | List all fields |
| [`mailerlite_list_forms_subscribers`](#mailerlite_list_forms_subscribers) | Get subscribers who signed up to a specific form |
| [`mailerlite_list_groups`](#mailerlite_list_groups) | List all groups |
| [`mailerlite_list_groups_subscribers`](#mailerlite_list_groups_subscribers) | Get subscribers belonging to a group |
| [`mailerlite_list_segments`](#mailerlite_list_segments) | List all segments |
| [`mailerlite_list_segments_subscribers`](#mailerlite_list_segments_subscribers) | Get subscribers belonging to a segment |
| [`mailerlite_list_subscribers`](#mailerlite_list_subscribers) | Fetch total subscribers count |
| [`mailerlite_list_webhooks`](#mailerlite_list_webhooks) | List all webhooks |
| [`mailerlite_schedule_campaigns_schedule`](#mailerlite_schedule_campaigns_schedule) | Schedule a campaign |
| [`mailerlite_unassign_subscribers_groups`](#mailerlite_unassign_subscribers_groups) | Unassign subscriber from a group |
| [`mailerlite_update_campaigns`](#mailerlite_update_campaigns) | Update campaign |
| [`mailerlite_update_fields`](#mailerlite_update_fields) | Update a field |
| [`mailerlite_update_forms`](#mailerlite_update_forms) | Update a form |
| [`mailerlite_update_groups`](#mailerlite_update_groups) | Update a group |
| [`mailerlite_update_segments`](#mailerlite_update_segments) | Update segment |
| [`mailerlite_update_webhooks`](#mailerlite_update_webhooks) | Update a webhook |
***
## mailerlite\_assign\_subscribers\_groups
Assign subscriber to a group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ----------------- |
| `subscriber_id` | string | Yes | — | The subscriber id |
| `group_id` | string | Yes | — | The group id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscriber_id": {
"type": "string",
"description": "The subscriber id"
},
"group_id": {
"type": "string",
"description": "The group id"
}
},
"required": [
"PCID",
"subscriber_id",
"group_id"
]
}
```
***
## mailerlite\_cancel\_campaigns\_cancel
Cancel a ready campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `campaign_id` | string | Yes | — | The campaign id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"campaign_id": {
"type": "string",
"description": "The campaign id"
}
},
"required": [
"PCID",
"campaign_id"
]
}
```
***
## mailerlite\_create\_campaigns
Create a campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `emails` | object\[] | No | — | Campaign email configurations |
| `name` | string | No | — | Maximum string length of 255 characters |
| `type` | string | No | — | Must be one of the following: regular, ab, resend. Type resend is only available for accounts on growing or advanced plans |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "Maximum string length of 255 characters"
},
"from_name": {
"type": "string",
"description": "Maximum string length of 255 characters"
},
"from": {
"type": "string",
"description": "Must be a valid email address that has been already verified on MailerLite"
}
}
},
"description": "Campaign email configurations"
},
"name": {
"type": "string",
"description": "Maximum string length of 255 characters"
},
"type": {
"type": "string",
"description": "Must be one of the following: regular, ab, resend. Type resend is only available for accounts on growing or advanced plans"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_create\_fields
Create a field
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `name` | string | No | — | Maximum length of 255 characters |
| `type` | string | No | — | Can be text, number or date |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"name": {
"type": "string",
"description": "Maximum length of 255 characters"
},
"type": {
"type": "string",
"description": "Can be text, number or date"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_create\_groups
Create a group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------- |
| `name` | string | No | — | Maximum length of 255 characters |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Maximum length of 255 characters"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_create\_subscribers
Create/upsert subscriber
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| `email` | string | No | — | Valid email address as per RFC 2821 |
| `fields` | object | No | — | Subscriber fields. Keys are field names (e.g. name, last\_name, company). |
| `groups` | string\[] | No | — | array must contain existing group ids. Subscriber can only be added to groups this way and will not be removed by omission |
| `ip_address` | string | No | — | Must be a valid ip address |
| `opted_in_at` | string | No | — | Must be a valid date in the format yyyy-MM-dd HH:mm:ss |
| `optin_ip` | string | No | — | Must be a valid ip address |
| `status` | string | No | — | Can be one of the following: active, unsubscribed, unconfirmed, bounced, junk |
| `subscribed_at` | string | No | — | Must be a valid date in the format yyyy-MM-dd HH:mm:ss |
| `unsubscribed_at` | string | No | — | Must be a valid date in the format yyyy-MM-dd HH:mm:ss |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "Valid email address as per RFC 2821"
},
"fields": {
"type": "object",
"description": "Subscriber fields. Keys are field names (e.g. name, last_name, company)."
},
"groups": {
"type": "array",
"items": {
"type": "string"
},
"description": "array must contain existing group ids. Subscriber can only be added to groups this way and will not be removed by omission"
},
"ip_address": {
"type": "string",
"description": "Must be a valid ip address"
},
"opted_in_at": {
"type": "string",
"description": "Must be a valid date in the format yyyy-MM-dd HH:mm:ss"
},
"optin_ip": {
"type": "string",
"description": "Must be a valid ip address"
},
"status": {
"type": "string",
"description": "Can be one of the following: active, unsubscribed, unconfirmed, bounced, junk"
},
"subscribed_at": {
"type": "string",
"description": "Must be a valid date in the format yyyy-MM-dd HH:mm:ss"
},
"unsubscribed_at": {
"type": "string",
"description": "Must be a valid date in the format yyyy-MM-dd HH:mm:ss"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_create\_webhooks
Create a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------ |
| `Content-Type` | string | No | — | The content-type value |
| `events` | string\[] | No | — | Must be one of the events described in following table |
| `name` | string | No | — | The name value |
| `url` | string | No | — | The url value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must be one of the events described in following table"
},
"name": {
"type": "string",
"description": "The name value"
},
"url": {
"type": "string",
"description": "The url value"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_delete\_campaigns
Delete a campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `campaign_id` | string | Yes | — | The campaign id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"campaign_id": {
"type": "string",
"description": "The campaign id"
}
},
"required": [
"PCID",
"campaign_id"
]
}
```
***
## mailerlite\_delete\_fields
Delete a field
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `field_id` | string | Yes | — | The field id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"field_id": {
"type": "string",
"description": "The field id"
}
},
"required": [
"PCID",
"field_id"
]
}
```
***
## mailerlite\_delete\_forms
Delete a form
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `form_id` | string | Yes | — | The form id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"form_id": {
"type": "string",
"description": "The form id"
}
},
"required": [
"PCID",
"form_id"
]
}
```
***
## mailerlite\_delete\_groups
Delete group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------ |
| `group_id` | string | Yes | — | The group id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_id": {
"type": "string",
"description": "The group id"
}
},
"required": [
"PCID",
"group_id"
]
}
```
***
## mailerlite\_delete\_segments
Delete segment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------- |
| `segment_id` | string | Yes | — | The segment id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"segment_id": {
"type": "string",
"description": "The segment id"
}
},
"required": [
"PCID",
"segment_id"
]
}
```
***
## mailerlite\_delete\_subscribers
Delete a subscriber
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ----------------- |
| `subscriber_id` | string | Yes | — | The subscriber id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscriber_id": {
"type": "string",
"description": "The subscriber id"
}
},
"required": [
"PCID",
"subscriber_id"
]
}
```
***
## mailerlite\_delete\_webhooks
Delete a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `webhook_id` | string | Yes | — | The webhook id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"webhook_id": {
"type": "string",
"description": "The webhook id"
}
},
"required": [
"PCID",
"webhook_id"
]
}
```
***
## mailerlite\_get\_automations
Get an automation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `automation_id` | string | Yes | — | The automation id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"automation_id": {
"type": "string",
"description": "The automation id"
}
},
"required": [
"PCID",
"automation_id"
]
}
```
***
## mailerlite\_get\_automations\_activity
Get the subscriber activity for an automation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ----------------------------------------------------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `filter[status]` | string | No | — | Must be one of the following: completed, active, canceled, failed |
| `automation_id` | string | Yes | — | The automation id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"filter[status]": {
"type": "string",
"description": "Must be one of the following: completed, active, canceled, failed"
},
"automation_id": {
"type": "string",
"description": "The automation id"
}
},
"required": [
"PCID",
"automation_id"
]
}
```
***
## mailerlite\_get\_campaigns
Get a campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `campaign_id` | string | Yes | — | The campaign id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"campaign_id": {
"type": "string",
"description": "The campaign id"
}
},
"required": [
"PCID",
"campaign_id"
]
}
```
***
## mailerlite\_get\_campaigns\_reports\_subscriber\_activity
Get subscribers' activity of a sent campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `campaign_id` | string | Yes | — | The campaign id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"campaign_id": {
"type": "string",
"description": "The campaign id"
}
},
"required": [
"PCID",
"campaign_id"
]
}
```
***
## mailerlite\_get\_forms
Get a form
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `form_id` | string | Yes | — | The form id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"form_id": {
"type": "string",
"description": "The form id"
}
},
"required": [
"PCID",
"form_id"
]
}
```
***
## mailerlite\_get\_forms\_popup
List all forms
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_get\_subscribers
Fetch a subscriber
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ----------------- |
| `subscriber_id` | string | Yes | — | The subscriber id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscriber_id": {
"type": "string",
"description": "The subscriber id"
}
},
"required": [
"PCID",
"subscriber_id"
]
}
```
***
## mailerlite\_get\_subscribers\_import
Get single import
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------- |
| `import_id` | string | Yes | — | The import id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"import_id": {
"type": "string",
"description": "The import id"
}
},
"required": [
"PCID",
"import_id"
]
}
```
***
## mailerlite\_get\_subscribers\_stats
Get subscriber statistics
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------ |
| `X-Locale` | string | No | — | The x-locale value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"X-Locale": {
"type": "string",
"description": "The x-locale value"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_get\_webhooks
Get a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `webhook_id` | string | Yes | — | The webhook id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"webhook_id": {
"type": "string",
"description": "The webhook id"
}
},
"required": [
"PCID",
"webhook_id"
]
}
```
***
## mailerlite\_list\_automations
List all automations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_list\_campaigns
Campaigns list
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_list\_fields
List all fields
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_list\_forms\_subscribers
Get subscribers who signed up to a specific form
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `form_id` | string | Yes | — | The form id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"form_id": {
"type": "string",
"description": "The form id"
}
},
"required": [
"PCID",
"form_id"
]
}
```
***
## mailerlite\_list\_groups
List all groups
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_list\_groups\_subscribers
Get subscribers belonging to a group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------ |
| `group_id` | string | Yes | — | The group id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_id": {
"type": "string",
"description": "The group id"
}
},
"required": [
"PCID",
"group_id"
]
}
```
***
## mailerlite\_list\_segments
List all segments
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_list\_segments\_subscribers
Get subscribers belonging to a segment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------- |
| `segment_id` | string | Yes | — | The segment id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"segment_id": {
"type": "string",
"description": "The segment id"
}
},
"required": [
"PCID",
"segment_id"
]
}
```
***
## mailerlite\_list\_subscribers
Fetch total subscribers count
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_list\_webhooks
List all webhooks
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `Content-Type` | string | No | — | The content-type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
}
},
"required": [
"PCID"
]
}
```
***
## mailerlite\_schedule\_campaigns\_schedule
Schedule a campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ----------------------------------------------------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `campaign_id` | string | Yes | — | The campaign id |
| `delivery` | string | No | — | Must be one of the following: instant, scheduled, timezone\_based |
| `resend` | object | No | — | Resend configuration |
| `schedule` | object | No | — | Schedule configuration |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"campaign_id": {
"type": "string",
"description": "The campaign id"
},
"delivery": {
"type": "string",
"description": "Must be one of the following: instant, scheduled, timezone_based"
},
"resend": {
"type": "object",
"description": "Resend configuration",
"properties": {
"delivery": {
"type": "string",
"description": "Must be Must be one of the following: day, scheduled"
},
"date": {
"type": "string",
"description": "Must be a date in the future"
},
"hours": {
"type": "string",
"description": "Must be a valid hour in HH format"
},
"minutes": {
"type": "string",
"description": "Must be a valid minute in ii format"
},
"timezone_id": {
"type": "string",
"description": "Must be a valid timezone id, defaults to the account's timezone id"
}
}
},
"schedule": {
"type": "object",
"description": "Schedule configuration",
"properties": {
"date": {
"type": "string",
"description": "Must be a date in the future"
},
"hours": {
"type": "string",
"description": "Must be a valid hour in HH format"
},
"minutes": {
"type": "string",
"description": "Must be a valid minute in ii format"
},
"timezone_id": {
"type": "string",
"description": "Must be a valid timezone id, defaults to the account's timezone id"
}
}
}
},
"required": [
"PCID",
"campaign_id"
]
}
```
***
## mailerlite\_unassign\_subscribers\_groups
Unassign subscriber from a group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ----------------- |
| `subscriber_id` | string | Yes | — | The subscriber id |
| `group_id` | string | Yes | — | The group id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subscriber_id": {
"type": "string",
"description": "The subscriber id"
},
"group_id": {
"type": "string",
"description": "The group id"
}
},
"required": [
"PCID",
"subscriber_id",
"group_id"
]
}
```
***
## mailerlite\_update\_campaigns
Update campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `campaign_id` | string | Yes | — | The campaign id |
| `emails` | object\[] | No | — | Campaign email configurations |
| `name` | string | No | — | Maximum string length of 255 characters |
| `type` | string | No | — | Must be one of the following: regular, ab, resend. Type resend is only available for accounts on growing or advanced plans |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"campaign_id": {
"type": "string",
"description": "The campaign id"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "Maximum string length of 255 characters"
},
"from_name": {
"type": "string",
"description": "Maximum string length of 255 characters"
},
"from": {
"type": "string",
"description": "Must be a valid email address that has been already verified on MailerLite"
}
}
},
"description": "Campaign email configurations"
},
"name": {
"type": "string",
"description": "Maximum string length of 255 characters"
},
"type": {
"type": "string",
"description": "Must be one of the following: regular, ab, resend. Type resend is only available for accounts on growing or advanced plans"
}
},
"required": [
"PCID",
"campaign_id"
]
}
```
***
## mailerlite\_update\_fields
Update a field
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `field_id` | string | Yes | — | The field id |
| `name` | string | No | — | Maximum length of 255 characters |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"field_id": {
"type": "string",
"description": "The field id"
},
"name": {
"type": "string",
"description": "Maximum length of 255 characters"
}
},
"required": [
"PCID",
"field_id"
]
}
```
***
## mailerlite\_update\_forms
Update a form
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------- |
| `Content-Type` | string | No | — | The content-type value |
| `form_id` | string | Yes | — | The form id |
| `name` | string | No | — | Maximum length of 255 characters |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"form_id": {
"type": "string",
"description": "The form id"
},
"name": {
"type": "string",
"description": "Maximum length of 255 characters"
}
},
"required": [
"PCID",
"form_id"
]
}
```
***
## mailerlite\_update\_groups
Update a group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `group_id` | string | Yes | — | The group id |
| `name` | string | No | — | New name for the group. Maximum length of 255 characters |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_id": {
"type": "string",
"description": "The group id"
},
"name": {
"type": "string",
"description": "New name for the group. Maximum length of 255 characters"
}
},
"required": [
"PCID",
"group_id"
]
}
```
***
## mailerlite\_update\_segments
Update segment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `segment_id` | string | Yes | — | The segment id |
| `name` | string | No | — | Maximum length of 255 characters |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"segment_id": {
"type": "string",
"description": "The segment id"
},
"name": {
"type": "string",
"description": "Maximum length of 255 characters"
}
},
"required": [
"PCID",
"segment_id"
]
}
```
***
## mailerlite\_update\_webhooks
Update a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------ |
| `Content-Type` | string | No | — | The content-type value |
| `webhook_id` | string | Yes | — | The webhook id |
| `enabled` | boolean | No | — | Whether the webhook is enabled |
| `events` | string\[] | No | — | Must be one of the events described in following table |
| `name` | string | No | — | The name value |
| `url` | string | No | — | The url value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
},
"webhook_id": {
"type": "string",
"description": "The webhook id"
},
"enabled": {
"type": "boolean",
"description": "Whether the webhook is enabled"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must be one of the events described in following table"
},
"name": {
"type": "string",
"description": "The name value"
},
"url": {
"type": "string",
"description": "The url value"
}
},
"required": [
"PCID",
"webhook_id"
]
}
```