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.
Server path: /mailerlite | Type: Application | PCID required: Yes
mailerlite_assign_subscribers_groups
Assign subscriber to a group
Parameters:
Parameter Type Required Default Description subscriber_idstring Yes — The subscriber id group_idstring Yes — The group id
{
"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 campaign_idstring Yes — The campaign id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"campaign_id" : {
"type" : "string" ,
"description" : "The campaign id"
}
},
"required" : [
"PCID" ,
"campaign_id"
]
}
mailerlite_create_campaigns
Create a campaign
Parameters:
Parameter Type Required Default Description emailsobject[] No — Campaign email configurations namestring No — Maximum string length of 255 characters typestring No — Must be one of the following: regular, ab, resend. Type resend is only available for accounts on growing or advanced plans
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"emails" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"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 namestring No — Maximum length of 255 characters typestring No — Can be text, number or date
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"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 namestring No — Maximum length of 255 characters
{
"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 emailstring No — Valid email address as per RFC 2821 fieldsobject No — Subscriber fields. Keys are field names (e.g. name, last_name, company). groupsstring[] No — array must contain existing group ids. Subscriber can only be added to groups this way and will not be removed by omission ip_addressstring No — Must be a valid ip address opted_in_atstring No — Must be a valid date in the format yyyy-MM-dd HH:mm:ss optin_ipstring No — Must be a valid ip address statusstring No — Can be one of the following: active, unsubscribed, unconfirmed, bounced, junk subscribed_atstring No — Must be a valid date in the format yyyy-MM-dd HH:mm:ss unsubscribed_atstring No — Must be a valid date in the format yyyy-MM-dd HH:mm:ss
{
"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 eventsstring[] No — Must be one of the events described in following table namestring No — The name value urlstring No — The url value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"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 campaign_idstring Yes — The campaign id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"campaign_id" : {
"type" : "string" ,
"description" : "The campaign id"
}
},
"required" : [
"PCID" ,
"campaign_id"
]
}
mailerlite_delete_fields
Delete a field
Parameters:
Parameter Type Required Default Description field_idstring Yes — The field id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"field_id" : {
"type" : "string" ,
"description" : "The field id"
}
},
"required" : [
"PCID" ,
"field_id"
]
}
Delete a form
Parameters:
Parameter Type Required Default Description form_idstring Yes — The form id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "The form id"
}
},
"required" : [
"PCID" ,
"form_id"
]
}
mailerlite_delete_groups
Delete group
Parameters:
Parameter Type Required Default Description group_idstring Yes — The group id
{
"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_idstring Yes — The segment id
{
"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_idstring Yes — The subscriber id
{
"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 webhook_idstring Yes — The webhook id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"webhook_id" : {
"type" : "string" ,
"description" : "The webhook id"
}
},
"required" : [
"PCID" ,
"webhook_id"
]
}
mailerlite_get_automations
Get an automation
Parameters:
Parameter Type Required Default Description automation_idstring Yes — The automation id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"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 filter[status]string No — Must be one of the following: completed, active, canceled, failed automation_idstring Yes — The automation id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"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 campaign_idstring Yes — The campaign id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"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 campaign_idstring Yes — The campaign id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"campaign_id" : {
"type" : "string" ,
"description" : "The campaign id"
}
},
"required" : [
"PCID" ,
"campaign_id"
]
}
Get a form
Parameters:
Parameter Type Required Default Description form_idstring Yes — The form id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "The form id"
}
},
"required" : [
"PCID" ,
"form_id"
]
}
List all forms
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
mailerlite_get_subscribers
Fetch a subscriber
Parameters:
Parameter Type Required Default Description subscriber_idstring Yes — The subscriber id
{
"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_idstring Yes — The import id
{
"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
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
mailerlite_get_webhooks
Get a webhook
Parameters:
Parameter Type Required Default Description webhook_idstring Yes — The webhook id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"webhook_id" : {
"type" : "string" ,
"description" : "The webhook id"
}
},
"required" : [
"PCID" ,
"webhook_id"
]
}
mailerlite_list_automations
List all automations
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
mailerlite_list_campaigns
Campaigns list
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
mailerlite_list_fields
List all fields
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
Get subscribers who signed up to a specific form
Parameters:
Parameter Type Required Default Description form_idstring Yes — The form id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "The form id"
}
},
"required" : [
"PCID" ,
"form_id"
]
}
mailerlite_list_groups
List all groups
{
"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_idstring Yes — The group id
{
"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
{
"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_idstring Yes — The segment id
{
"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
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
mailerlite_list_webhooks
List all webhooks
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
mailerlite_schedule_campaigns_schedule
Schedule a campaign
Parameters:
Parameter Type Required Default Description campaign_idstring Yes — The campaign id deliverystring No — Must be one of the following: instant, scheduled, timezone_based resendobject No — Resend configuration scheduleobject No — Schedule configuration
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"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_idstring Yes — The subscriber id group_idstring Yes — The group id
{
"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 campaign_idstring Yes — The campaign id emailsobject[] No — Campaign email configurations namestring No — Maximum string length of 255 characters typestring No — Must be one of the following: regular, ab, resend. Type resend is only available for accounts on growing or advanced plans
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"campaign_id" : {
"type" : "string" ,
"description" : "The campaign id"
},
"emails" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"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 field_idstring Yes — The field id namestring No — Maximum length of 255 characters
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"field_id" : {
"type" : "string" ,
"description" : "The field id"
},
"name" : {
"type" : "string" ,
"description" : "Maximum length of 255 characters"
}
},
"required" : [
"PCID" ,
"field_id"
]
}
Update a form
Parameters:
Parameter Type Required Default Description form_idstring Yes — The form id namestring No — Maximum length of 255 characters
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"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_idstring Yes — The group id namestring No — New name for the group. Maximum length of 255 characters
{
"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_idstring Yes — The segment id namestring No — Maximum length of 255 characters
{
"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 webhook_idstring Yes — The webhook id enabledboolean No — Whether the webhook is enabled eventsstring[] No — Must be one of the events described in following table namestring No — The name value urlstring No — The url value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"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"
]
}