/mailchimp-campaigns | Type: Application | PCID required: Yes
Tools
mailchimp_campaigns_delete_campaign_folders_id
Delete campaign folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folder_id | string | Yes | — | The unique id for the campaign folder. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"folder_id": {
"type": "string",
"description": "The unique id for the campaign folder."
}
},
"required": [
"PCID",
"folder_id"
]
}
mailchimp_campaigns_delete_id
Delete campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_delete_id_feedback_id
Delete campaign feedback message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
feedback_id | string | Yes | — | The unique id for the feedback message. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "string",
"description": "The unique id for the feedback message."
}
},
"required": [
"PCID",
"campaign_id",
"feedback_id"
]
}
mailchimp_campaigns_get_campaign_folders
List campaign folders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
}
},
"required": [
"PCID"
]
}
mailchimp_campaigns_get_campaign_folders_id
Get campaign folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
folder_id | string | Yes | — | The unique id for the campaign folder. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"folder_id": {
"type": "string",
"description": "The unique id for the campaign folder."
}
},
"required": [
"PCID",
"folder_id"
]
}
mailchimp_campaigns_get_campaigns
List campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
type | string | No | — | The campaign type. |
status | string | No | — | The status of the campaign. |
before_send_time | string | No | — | Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
since_send_time | string | No | — | Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
before_create_time | string | No | — | Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
since_create_time | string | No | — | Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
list_id | string | No | — | The unique id for the list. |
folder_id | string | No | — | The unique folder id. |
member_id | string | No | — | Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address. |
sort_field | string | No | — | Returns files sorted by the specified field. |
sort_dir | string | No | — | Determines the order direction for sorted results. |
include_resend_shortcut_eligibility | boolean | No | — | Return the resend_shortcut_eligibility field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered. |
include_resend_shortcut_usage | boolean | No | — | Return the resend_shortcut_usage field in the response. This includes information about campaigns related by a shortcut. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"type": {
"type": "string",
"description": "The campaign type.",
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
]
},
"status": {
"type": "string",
"description": "The status of the campaign.",
"enum": [
"save",
"paused",
"schedule",
"sending",
"sent"
]
},
"before_send_time": {
"type": "string",
"description": "Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"since_send_time": {
"type": "string",
"description": "Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"before_create_time": {
"type": "string",
"description": "Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"since_create_time": {
"type": "string",
"description": "Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"list_id": {
"type": "string",
"description": "The unique id for the list."
},
"folder_id": {
"type": "string",
"description": "The unique folder id."
},
"member_id": {
"type": "string",
"description": "Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address."
},
"sort_field": {
"type": "string",
"description": "Returns files sorted by the specified field.",
"enum": [
"create_time",
"send_time"
]
},
"sort_dir": {
"type": "string",
"description": "Determines the order direction for sorted results.",
"enum": [
"ASC",
"DESC"
]
},
"include_resend_shortcut_eligibility": {
"type": "boolean",
"description": "Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered."
},
"include_resend_shortcut_usage": {
"type": "boolean",
"description": "Return the `resend_shortcut_usage` field in the response. This includes information about campaigns related by a shortcut."
}
},
"required": [
"PCID"
]
}
mailchimp_campaigns_get_id
Get campaign info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
include_resend_shortcut_eligibility | boolean | No | — | Return the resend_shortcut_eligibility field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered. |
include_resend_shortcut_usage | boolean | No | — | Return the resend_shortcut_usage field in the response. This includes information about campaigns related by a shortcut. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"include_resend_shortcut_eligibility": {
"type": "boolean",
"description": "Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered."
},
"include_resend_shortcut_usage": {
"type": "boolean",
"description": "Return the `resend_shortcut_usage` field in the response. This includes information about campaigns related by a shortcut."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_get_id_content
Get campaign content Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_get_id_feedback
List campaign feedback Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_get_id_feedback_id
Get campaign feedback message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
feedback_id | string | Yes | — | The unique id for the feedback message. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "string",
"description": "The unique id for the feedback message."
}
},
"required": [
"PCID",
"campaign_id",
"feedback_id"
]
}
mailchimp_campaigns_get_id_send_checklist
Get campaign send checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_get_search_campaigns
Search campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
query | string | Yes | — | The search query used to filter results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"query": {
"type": "string",
"description": "The search query used to filter results."
}
},
"required": [
"PCID",
"query"
]
}
mailchimp_campaigns_patch_campaign_folders_id
Update campaign folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folder_id | string | Yes | — | The unique id for the campaign folder. |
name | string | No | — | Name to associate with the folder. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"folder_id": {
"type": "string",
"description": "The unique id for the campaign folder."
},
"name": {
"type": "string",
"description": "Name to associate with the folder."
}
},
"required": [
"PCID",
"folder_id"
]
}
mailchimp_campaigns_patch_id
Update campaign settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
recipients | object | No | — | List settings for the campaign. |
rss_opts | object | No | — | RSS options for a campaign. |
settings | object | No | — | The settings for your campaign, including subject, from name, reply-to address, and more. |
social_card | object | No | — | The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more. |
tracking | object | No | — | The tracking options for a campaign. |
variate_settings | object | No | — | The settings specific to A/B test campaigns. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"recipients": {
"type": "object",
"description": "List settings for the campaign.",
"properties": {
"list_id": {
"type": "string",
"description": "The unique list id."
},
"segment_opts": {
"type": "object",
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
}
},
"required": [
"list_id"
]
},
"rss_opts": {
"type": "object",
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign.",
"properties": {
"feed_url": {
"type": "string",
"description": "The URL for the RSS feed."
},
"frequency": {
"type": "string",
"description": "The frequency of the RSS Campaign.",
"enum": [
"daily",
"weekly",
"monthly"
]
},
"schedule": {
"type": "object",
"description": "The schedule for sending the RSS Campaign."
},
"constrain_rss_img": {
"type": "boolean",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"required": [
"feed_url",
"frequency"
]
},
"settings": {
"type": "object",
"description": "The settings for your campaign, including subject, from name, reply-to address, and more.",
"properties": {
"subject_line": {
"type": "string",
"description": "The subject line for the campaign."
},
"preview_text": {
"type": "string",
"description": "The preview text for the campaign."
},
"title": {
"type": "string",
"description": "The title of the campaign."
},
"from_name": {
"type": "string",
"description": "The 'from' name on the campaign (not an email address)."
},
"reply_to": {
"type": "string",
"description": "The reply-to email address for the campaign."
},
"use_conversation": {
"type": "boolean",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
},
"to_name": {
"type": "string",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"folder_id": {
"type": "string",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"authenticate": {
"type": "boolean",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_footer": {
"type": "boolean",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"inline_css": {
"type": "boolean",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_tweet": {
"type": "boolean",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"fb_comments": {
"type": "boolean",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"description": "The id of the template to use."
}
},
"required": [
"subject_line",
"from_name",
"reply_to"
]
},
"social_card": {
"type": "object",
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/).",
"properties": {
"image_url": {
"type": "string",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"description": "A short summary of the campaign to display."
},
"title": {
"type": "string",
"description": "The title for the card. Typically the subject line of the campaign."
}
}
},
"tracking": {
"type": "object",
"description": "The tracking options for a campaign.",
"properties": {
"opens": {
"type": "boolean",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"html_clicks": {
"type": "boolean",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"description": "Whether to enable e-commerce tracking."
},
"google_analytics": {
"type": "string",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
},
"clicktale": {
"type": "string",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"description": "Deprecated"
},
"capsule": {
"type": "object",
"description": "Deprecated"
}
}
},
"variate_settings": {
"type": "object",
"description": "The settings specific to A/B test campaigns.",
"properties": {
"winner_criteria": {
"type": "string",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application.",
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
]
},
"wait_time": {
"type": "integer",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"test_size": {
"type": "integer",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
}
},
"required": [
"winner_criteria"
]
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_patch_id_feedback_id
Update campaign feedback message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
feedback_id | string | Yes | — | The unique id for the feedback message. |
block_id | integer | No | — | The block id for the editable block that the feedback addresses. |
is_complete | boolean | No | — | The status of feedback. |
message | string | No | — | The content of the feedback. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "string",
"description": "The unique id for the feedback message."
},
"block_id": {
"type": "integer",
"description": "The block id for the editable block that the feedback addresses."
},
"is_complete": {
"type": "boolean",
"description": "The status of feedback."
},
"message": {
"type": "string",
"description": "The content of the feedback."
}
},
"required": [
"PCID",
"campaign_id",
"feedback_id"
]
}
mailchimp_campaigns_post_campaign_folders
Add campaign folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name to associate with the folder. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Name to associate with the folder."
}
},
"required": [
"PCID",
"name"
]
}
mailchimp_campaigns_post_campaigns
Add campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content_type | string | No | — | How the campaign’s content is put together. The old drag and drop editor uses ‘template’ while the new editor uses ‘multichannel’. Defaults to template. |
recipients | object | No | — | List settings for the campaign. |
rss_opts | object | No | — | RSS options, specific to an RSS campaign. |
settings | object | No | — | The settings for your campaign, including subject, from name, reply-to address, and more. |
social_card | object | No | — | The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more. |
tracking | object | No | — | The tracking options for a campaign. |
type | string | Yes | — | There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. |
variate_settings | object | No | — | The settings specific to A/B test campaigns. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content_type": {
"type": "string",
"description": "How the campaign's content is put together. The old drag and drop editor uses 'template' while the new editor uses 'multichannel'. Defaults to template.",
"enum": [
"template",
"multichannel"
]
},
"recipients": {
"type": "object",
"description": "List settings for the campaign.",
"properties": {
"list_id": {
"type": "string",
"description": "The unique list id."
},
"segment_opts": {
"type": "object",
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
}
},
"required": [
"list_id"
]
},
"rss_opts": {
"type": "object",
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options, specific to an RSS campaign.",
"properties": {
"feed_url": {
"type": "string",
"description": "The URL for the RSS feed."
},
"frequency": {
"type": "string",
"description": "The frequency of the RSS Campaign.",
"enum": [
"daily",
"weekly",
"monthly"
]
},
"schedule": {
"type": "object",
"description": "The schedule for sending the RSS Campaign."
},
"constrain_rss_img": {
"type": "boolean",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"required": [
"feed_url",
"frequency"
]
},
"settings": {
"type": "object",
"description": "The settings for your campaign, including subject, from name, reply-to address, and more.",
"properties": {
"subject_line": {
"type": "string",
"description": "The subject line for the campaign."
},
"preview_text": {
"type": "string",
"description": "The preview text for the campaign."
},
"title": {
"type": "string",
"description": "The title of the campaign."
},
"from_name": {
"type": "string",
"description": "The 'from' name on the campaign (not an email address)."
},
"reply_to": {
"type": "string",
"description": "The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending."
},
"use_conversation": {
"type": "boolean",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
},
"to_name": {
"type": "string",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"folder_id": {
"type": "string",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"authenticate": {
"type": "boolean",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_footer": {
"type": "boolean",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"inline_css": {
"type": "boolean",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_tweet": {
"type": "boolean",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"fb_comments": {
"type": "boolean",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"description": "The id of the template to use."
}
}
},
"social_card": {
"type": "object",
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/).",
"properties": {
"image_url": {
"type": "string",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"description": "A short summary of the campaign to display."
},
"title": {
"type": "string",
"description": "The title for the card. Typically the subject line of the campaign."
}
}
},
"tracking": {
"type": "object",
"description": "The tracking options for a campaign.",
"properties": {
"opens": {
"type": "boolean",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"html_clicks": {
"type": "boolean",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"description": "Whether to enable e-commerce tracking."
},
"google_analytics": {
"type": "string",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
},
"clicktale": {
"type": "string",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"description": "Deprecated"
},
"capsule": {
"type": "object",
"description": "Deprecated"
}
}
},
"type": {
"type": "string",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.",
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
]
},
"variate_settings": {
"type": "object",
"description": "The settings specific to A/B test campaigns.",
"properties": {
"winner_criteria": {
"type": "string",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application.",
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
]
},
"wait_time": {
"type": "integer",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"test_size": {
"type": "integer",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
}
},
"required": [
"winner_criteria"
]
}
},
"required": [
"PCID",
"type"
]
}
mailchimp_campaigns_post_id_actions_cancel_send
Cancel campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_post_id_actions_create_resend
Resend campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
shortcut_type | string | No | — | Which campaign resend shortcut to use. Default is to_non_openers. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"shortcut_type": {
"type": "string",
"description": "Which campaign resend shortcut to use. Default is `to_non_openers`.",
"enum": [
"to_non_openers",
"to_new_subscribers",
"to_non_clickers",
"to_non_purchasers"
]
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_post_id_actions_pause
Pause rss campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_post_id_actions_replicate
Replicate campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_post_id_actions_resume
Resume rss campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_post_id_actions_schedule
Schedule campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
batch_delivery | object | No | — | Choose whether the campaign should use Batch Delivery. Cannot be set to true for campaigns using Timewarp. |
schedule_time | string | Yes | — | The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45). |
timewarp | boolean | No | — | Choose whether the campaign should use Timewarp when sending. Campaigns scheduled with Timewarp are localized based on the recipients’ time zones. For example, a Timewarp campaign with a schedule_time of 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set to true for campaigns using Batch Delivery. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"batch_delivery": {
"type": "object",
"description": "Choose whether the campaign should use [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/). Cannot be set to `true` for campaigns using [Timewarp](https://mailchimp.com/help/use-timewarp/).",
"properties": {
"batch_delay": {
"type": "integer",
"description": "The delay, in minutes, between batches."
},
"batch_count": {
"type": "integer",
"description": "The number of batches for the campaign send."
}
},
"required": [
"batch_delay",
"batch_count"
]
},
"schedule_time": {
"type": "string",
"description": "The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45)."
},
"timewarp": {
"type": "boolean",
"description": "Choose whether the campaign should use [Timewarp](https://mailchimp.com/help/use-timewarp/) when sending. Campaigns scheduled with Timewarp are localized based on the recipients' time zones. For example, a Timewarp campaign with a `schedule_time` of 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set to `true` for campaigns using [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/)."
}
},
"required": [
"PCID",
"campaign_id",
"schedule_time"
]
}
mailchimp_campaigns_post_id_actions_send
Send campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_post_id_actions_test
Send test email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
send_type | string | Yes | — | Choose the type of test email to send. |
test_emails | string[] | Yes | — | An array of email addresses to send the test email to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"send_type": {
"type": "string",
"description": "Choose the type of test email to send.",
"enum": [
"html",
"plaintext"
]
},
"test_emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of email addresses to send the test email to."
}
},
"required": [
"PCID",
"campaign_id",
"send_type",
"test_emails"
]
}
mailchimp_campaigns_post_id_actions_unschedule
Unschedule campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_campaigns_post_id_feedback
Add campaign feedback Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
block_id | integer | No | — | The block id for the editable block that the feedback addresses. |
is_complete | boolean | No | — | The status of feedback. |
message | string | Yes | — | The content of the feedback. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"block_id": {
"type": "integer",
"description": "The block id for the editable block that the feedback addresses."
},
"is_complete": {
"type": "boolean",
"description": "The status of feedback."
},
"message": {
"type": "string",
"description": "The content of the feedback."
}
},
"required": [
"PCID",
"campaign_id",
"message"
]
}
mailchimp_campaigns_put_id_content
Set campaign content Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | The unique id for the campaign. |
archive | object | No | — | Available when uploading an archive to create campaign content. The archive should include all campaign content and images. Learn more. |
html | string | No | — | The raw HTML for the campaign. |
plain_text | string | No | — | The plain-text portion of the campaign. If left unspecified, we’ll generate this automatically. |
template | object | No | — | Use this template to generate the HTML content of the campaign |
url | string | No | — | When importing a campaign, the URL where the HTML lives. |
variate_contents | object[] | No | — | Content options for Multivariate Campaigns. Each content option must provide HTML content and may optionally provide plain text. For campaigns not testing content, only one object should be provided. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"archive": {
"type": "object",
"description": "Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/).",
"properties": {
"archive_content": {
"type": "string",
"description": "The base64-encoded representation of the archive file."
},
"archive_type": {
"type": "string",
"description": "The type of encoded file. Defaults to zip.",
"enum": [
"zip",
"tar.gz",
"tar.bz2",
"tar",
"tgz",
"tbz"
]
}
},
"required": [
"archive_content"
]
},
"html": {
"type": "string",
"description": "The raw HTML for the campaign."
},
"plain_text": {
"type": "string",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"template": {
"type": "object",
"description": "Use this template to generate the HTML content of the campaign",
"properties": {
"id": {
"type": "integer",
"description": "The id of the template to use."
},
"sections": {
"type": "object",
"description": "Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template."
}
},
"required": [
"id"
]
},
"url": {
"type": "string",
"description": "When importing a campaign, the URL where the HTML lives."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content_label": {
"type": "string",
"description": "The label used to identify the content option."
},
"plain_text": {
"type": "string",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"html": {
"type": "string",
"description": "The raw HTML for the campaign."
},
"url": {
"type": "string",
"description": "When importing a campaign, the URL for the HTML."
},
"template": {
"type": "object",
"description": "Use this template to generate the HTML content for the campaign."
},
"archive": {
"type": "object",
"description": "Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/)."
}
},
"required": [
"content_label"
]
},
"description": "Content options for [Multivariate Campaigns](https://mailchimp.com/help/about-multivariate-campaigns/). Each content option must provide HTML content and may optionally provide plain text. For campaigns not testing content, only one object should be provided."
}
},
"required": [
"PCID",
"campaign_id"
]
}