diff --git a/spec/marketing.json b/spec/marketing.json index 14f3f20..0432183 100644 --- a/spec/marketing.json +++ b/spec/marketing.json @@ -189,6 +189,9 @@ "paths": [ "/file-manager/folders", "/file-manager/folders/{folder_id}" + ], + "subResources": [ + "file-manager-folders-files" ] }, "file-manager-files": { @@ -199,6 +202,13 @@ "/file-manager/files/{file_id}" ] }, + "file-manager-folders-files": { + "title": "Files in Folder", + "description": "Manage specific files in a folder.", + "paths": [ + "/file-manager/folders/{folder_id}/files" + ] + }, "landing-pages": { "title": "Landing Pages", "description": "Manage your Landing Pages, including publishing and unpublishing.", @@ -209,10 +219,10 @@ "/landing-pages/{page_id}/actions/unpublish" ], "subResources": [ - "landing-pages_content" + "landing-pages-content" ] }, - "landing-pages_content": { + "landing-pages-content": { "title": "Content", "description": "The HTML content for your Mailchimp landing pages.", "paths": [ @@ -242,7 +252,8 @@ "lists-tags-search", "prebuilt-segments", "list-preview-segment", - "list-surveys" + "list-surveys", + "list-sms-program" ] }, "list-members": { @@ -316,7 +327,8 @@ "/lists/{list_id}/surveys", "/lists/{list_id}/surveys/{survey_id}", "/lists/{list_id}/surveys/{survey_id}/actions/publish", - "/lists/{list_id}/surveys/{survey_id}/actions/unpublish" + "/lists/{list_id}/surveys/{survey_id}/actions/unpublish", + "/lists/{list_id}/surveys/{survey_id}/actions/create-email" ] }, "interest-categories": { @@ -590,7 +602,8 @@ "ecommerce-orders", "ecommerce-products", "ecommerce-carts", - "ecommerce-promo-rules" + "ecommerce-promo-rules", + "ecommerce-collections" ] }, "ecommerce-customers": { @@ -735,10 +748,10 @@ }, "reporting-surveys": { "title": "Surveys", - "description": "Survey reports", + "description": "Get an overall report for a [hosted survey](https://mailchimp.com/help/create-a-survey/).", "paths": [ "/reporting/surveys", - "/reporting/surveys/{outreach_id}" + "/reporting/surveys/{survey_id}" ], "subResources": [ "reporting-surveys-questions", @@ -747,10 +760,10 @@ }, "reporting-surveys-questions": { "title": "Survey Questions", - "description": "Survey question reports", + "description": "Get reports by question on a [hosted survey](https://mailchimp.com/help/create-a-survey/).", "paths": [ - "/reporting/surveys/{outreach_id}/questions", - "/reporting/surveys/{outreach_id}/questions/{question_id}" + "/reporting/surveys/{survey_id}/questions", + "/reporting/surveys/{survey_id}/questions/{question_id}" ], "subResources": [ "reporting-surveys-questions-answers" @@ -758,17 +771,17 @@ }, "reporting-surveys-questions-answers": { "title": "Survey Question Answers", - "description": "Survey question answers", + "description": "Answers to specific questions on a [hosted survey](https://mailchimp.com/help/create-a-survey/).", "paths": [ - "/reporting/surveys/{outreach_id}/questions/{question_id}/answers" + "/reporting/surveys/{survey_id}/questions/{question_id}/answers" ] }, "reporting-surveys-responses": { "title": "Survey Responses", - "description": "Survey response reports", + "description": "Get survey response reports for a [hosted survey](https://mailchimp.com/help/create-a-survey/).", "paths": [ - "/reporting/surveys/{outreach_id}/responses", - "/reporting/surveys/{outreach_id}/responses/{response_id}" + "/reporting/surveys/{survey_id}/responses", + "/reporting/surveys/{survey_id}/responses/{response_id}" ] }, "search-campaigns": { @@ -800,7 +813,7 @@ }, "swagger": "2.0", "info": { - "version": "3.0.81", + "version": "3.0.82", "title": "Mailchimp Marketing API", "contact": { "name": "Mailchimp API Support", @@ -20217,6 +20230,13 @@ "readOnly": false, "example": "http://yourdomain.com/webhook" }, + "enabled": { + "type": "boolean", + "title": "Enabled", + "description": "Whether the webhook receives requests or not.", + "readOnly": false, + "example": true + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -20415,6 +20435,12 @@ "title": "URL", "description": "A valid URL for the Webhook.", "example": "http://yourdomain.com/webhook" + }, + "enabled": { + "type": "boolean", + "title": "Enabled", + "description": "Whether the webhook receives requests or not.", + "example": true } } } @@ -20441,6 +20467,13 @@ "readOnly": false, "example": "http://yourdomain.com/webhook" }, + "enabled": { + "type": "boolean", + "title": "Enabled", + "description": "Whether the webhook receives requests or not.", + "readOnly": false, + "example": true + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -20613,6 +20646,13 @@ "readOnly": false, "example": "http://yourdomain.com/webhook" }, + "enabled": { + "type": "boolean", + "title": "Enabled", + "description": "Whether the webhook receives requests or not.", + "readOnly": false, + "example": true + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -20746,15 +20786,18 @@ "type": "object", "title": "Batch Webhook", "description": "Update an existing Batch Webook.", - "required": [ - "url" - ], "properties": { "url": { "type": "string", "title": "URL", "description": "A valid URL for the Webhook.", "example": "http://yourdomain.com/webhook" + }, + "enabled": { + "type": "boolean", + "title": "Enabled", + "description": "Whether the webhook receives requests or not.", + "example": true } } } @@ -20781,6 +20824,13 @@ "readOnly": false, "example": "http://yourdomain.com/webhook" }, + "enabled": { + "type": "boolean", + "title": "Enabled", + "description": "Whether the webhook receives requests or not.", + "readOnly": false, + "example": true + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -22816,6 +22866,14 @@ "ASC", "DESC" ] + }, + { + "name": "include_resend_shortcut_eligibility", + "x-title": "Include Resend Shortcut Eligibility", + "in": "query", + "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.", + "required": false, + "type": "boolean" } ], "responses": { @@ -25509,6 +25567,192 @@ } } }, + "resend_shortcut_eligibility": { + "type": "object", + "title": "Resend Shortcut Eligibility", + "description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`.", + "properties": { + "to_non_openers": { + "type": "object", + "title": "To Non-Openers", + "description": "Determines if the campaign qualifies to be resent to non-openers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_new_subscribers": { + "type": "object", + "title": "To New Subscribers", + "description": "Determines if the campaign qualifies to be resent to new subscribers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_clickers": { + "type": "object", + "title": "To Non-Clickers", + "description": "Determines if the campaign qualifies to be resent to non-clickers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_purchasers": { + "type": "object", + "title": "To Non-Purchasers", + "description": "Determines if the campaign qualifies to be resent to non-purchasers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + } + } + }, + "resend_shortcut_usage": { + "type": "object", + "title": "Resend Shortcut Usage", + "description": "Information about campaigns related through shortcuts.", + "properties": { + "shortcut_campaigns": { + "type": "array", + "title": "Shortcut Campaigns", + "description": "Campaigns that were created from Campaign Resend Shortcuts for this campaign", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "Unique ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time a resent campaign was sent.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "enum": [ + "save", + "paused", + "schedule", + "sending", + "sent", + "canceled", + "canceling", + "archived" + ], + "readOnly": true + } + } + } + }, + "original_campaign": { + "type": "object", + "title": "Original Campaign", + "description": "The original campaign that was resent.", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of the original campaign.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + } + } + } + } + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -30675,6 +30919,192 @@ } } }, + "resend_shortcut_eligibility": { + "type": "object", + "title": "Resend Shortcut Eligibility", + "description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`.", + "properties": { + "to_non_openers": { + "type": "object", + "title": "To Non-Openers", + "description": "Determines if the campaign qualifies to be resent to non-openers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_new_subscribers": { + "type": "object", + "title": "To New Subscribers", + "description": "Determines if the campaign qualifies to be resent to new subscribers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_clickers": { + "type": "object", + "title": "To Non-Clickers", + "description": "Determines if the campaign qualifies to be resent to non-clickers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_purchasers": { + "type": "object", + "title": "To Non-Purchasers", + "description": "Determines if the campaign qualifies to be resent to non-purchasers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + } + } + }, + "resend_shortcut_usage": { + "type": "object", + "title": "Resend Shortcut Usage", + "description": "Information about campaigns related through shortcuts.", + "properties": { + "shortcut_campaigns": { + "type": "array", + "title": "Shortcut Campaigns", + "description": "Campaigns that were created from Campaign Resend Shortcuts for this campaign", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "Unique ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time a resent campaign was sent.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "enum": [ + "save", + "paused", + "schedule", + "sending", + "sent", + "canceled", + "canceling", + "archived" + ], + "readOnly": true + } + } + } + }, + "original_campaign": { + "type": "object", + "title": "Original Campaign", + "description": "The original campaign that was resent.", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of the original campaign.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + } + } + } + } + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -30825,6 +31255,22 @@ "type": "string", "required": true, "description": "The unique id for the campaign." + }, + { + "name": "include_resend_shortcut_eligibility", + "x-title": "Include Resend Shortcut Eligibility", + "in": "query", + "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.", + "required": false, + "type": "boolean" + }, + { + "name": "include_resend_shortcut_usage", + "x-title": "Include Resend Shortcut Usage", + "in": "query", + "description": "Return the `resend_shortcut_usage` field in the response. This includes information about campaigns related by a shortcut.", + "required": false, + "type": "boolean" } ], "responses": { @@ -33512,6 +33958,192 @@ } } }, + "resend_shortcut_eligibility": { + "type": "object", + "title": "Resend Shortcut Eligibility", + "description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`.", + "properties": { + "to_non_openers": { + "type": "object", + "title": "To Non-Openers", + "description": "Determines if the campaign qualifies to be resent to non-openers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_new_subscribers": { + "type": "object", + "title": "To New Subscribers", + "description": "Determines if the campaign qualifies to be resent to new subscribers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_clickers": { + "type": "object", + "title": "To Non-Clickers", + "description": "Determines if the campaign qualifies to be resent to non-clickers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_purchasers": { + "type": "object", + "title": "To Non-Purchasers", + "description": "Determines if the campaign qualifies to be resent to non-purchasers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + } + } + }, + "resend_shortcut_usage": { + "type": "object", + "title": "Resend Shortcut Usage", + "description": "Information about campaigns related through shortcuts.", + "properties": { + "shortcut_campaigns": { + "type": "array", + "title": "Shortcut Campaigns", + "description": "Campaigns that were created from Campaign Resend Shortcuts for this campaign", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "Unique ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time a resent campaign was sent.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "enum": [ + "save", + "paused", + "schedule", + "sending", + "sent", + "canceled", + "canceling", + "archived" + ], + "readOnly": true + } + } + } + }, + "original_campaign": { + "type": "object", + "title": "Original Campaign", + "description": "The original campaign that was resent.", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of the original campaign.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + } + } + } + } + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -38612,6 +39244,192 @@ } } }, + "resend_shortcut_eligibility": { + "type": "object", + "title": "Resend Shortcut Eligibility", + "description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`.", + "properties": { + "to_non_openers": { + "type": "object", + "title": "To Non-Openers", + "description": "Determines if the campaign qualifies to be resent to non-openers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_new_subscribers": { + "type": "object", + "title": "To New Subscribers", + "description": "Determines if the campaign qualifies to be resent to new subscribers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_clickers": { + "type": "object", + "title": "To Non-Clickers", + "description": "Determines if the campaign qualifies to be resent to non-clickers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_purchasers": { + "type": "object", + "title": "To Non-Purchasers", + "description": "Determines if the campaign qualifies to be resent to non-purchasers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + } + } + }, + "resend_shortcut_usage": { + "type": "object", + "title": "Resend Shortcut Usage", + "description": "Information about campaigns related through shortcuts.", + "properties": { + "shortcut_campaigns": { + "type": "array", + "title": "Shortcut Campaigns", + "description": "Campaigns that were created from Campaign Resend Shortcuts for this campaign", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "Unique ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time a resent campaign was sent.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "enum": [ + "save", + "paused", + "schedule", + "sending", + "sent", + "canceled", + "canceling", + "archived" + ], + "readOnly": true + } + } + } + }, + "original_campaign": { + "type": "object", + "title": "Original Campaign", + "description": "The original campaign that was resent.", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of the original campaign.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + } + } + } + } + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -42235,7 +43053,7 @@ "/campaigns/{campaign_id}/actions/create-resend": { "post": { "summary": "Resend campaign", - "description": "Creates a Resend to Non-Openers version of this campaign. We will also check if this campaign meets the criteria for Resend to Non-Openers campaigns.", + "description": "Remove the guesswork for resending a campaign to certain segments. You can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent.", "operationId": "postCampaignsIdActionsCreateResend", "x-pro-required": true, "parameters": [ @@ -42246,6 +43064,28 @@ "type": "string", "required": true, "description": "The unique id for the campaign." + }, + { + "in": "body", + "name": "body", + "description": "", + "required": false, + "schema": { + "type": "object", + "properties": { + "shortcut_type": { + "type": "string", + "title": "Resend Shortcut Type", + "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" + ] + } + } + } } ], "responses": { @@ -49123,7 +49963,9 @@ "required": false, "type": "string", "enum": [ - "added_date" + "added_date", + "name", + "size" ] }, { @@ -51092,11 +51934,394 @@ } } }, - "/lists": { + "/file-manager/folders/{folder_id}/files": { "get": { - "summary": "Get lists info", - "description": "Get information about all lists in the account.", - "operationId": "getLists", + "summary": "List stored files", + "description": "Get a list of available images and files stored in this folder.", + "operationId": "getFileManagerFoldersFiles", + "parameters": [ + { + "in": "path", + "name": "folder_id", + "x-title": "Folder ID", + "type": "string", + "required": true, + "description": "The unique id for the File Manager folder." + }, + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "count", + "x-title": "Count", + "in": "query", + "description": "The number of records to return. Default value is 10. Maximum value is 1000", + "required": false, + "default": 10, + "maximum": 1000, + "type": "integer" + }, + { + "name": "offset", + "x-title": "Offset", + "in": "query", + "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.", + "required": false, + "default": 0, + "type": "integer" + }, + { + "name": "type", + "x-title": "File Type", + "in": "query", + "description": "The file type for the File Manager file.", + "required": false, + "type": "string" + }, + { + "name": "created_by", + "x-title": "Created By", + "in": "query", + "description": "The Mailchimp account user who created the File Manager file.", + "required": false, + "type": "string" + }, + { + "name": "before_created_at", + "x-title": "Before Created At", + "in": "query", + "description": "Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.", + "required": false, + "type": "string" + }, + { + "name": "since_created_at", + "x-title": "Since Created At", + "in": "query", + "description": "Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.", + "required": false, + "type": "string" + }, + { + "name": "sort_field", + "x-title": "Sort By Field", + "description": "Returns files sorted by the specified field.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "added_date", + "name", + "size" + ] + }, + { + "name": "sort_dir", + "x-title": "Sort Direction", + "description": "Determines the order direction for sorted results.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "File Manager", + "description": "A list of available images and files stored in the File Manager for the account.", + "properties": { + "files": { + "type": "array", + "items": { + "type": "object", + "title": "Gallery File", + "description": "An individual file listed in the File Manager.", + "properties": { + "id": { + "type": "integer", + "title": "File ID", + "description": "The unique id of the file.", + "readOnly": true + }, + "folder_id": { + "type": "integer", + "title": "Folder ID", + "description": "The id of the folder." + }, + "type": { + "enum": [ + "image", + "file" + ], + "type": "string", + "title": "File Type", + "description": "The type of file in the File Manager.", + "readOnly": true + }, + "name": { + "type": "string", + "title": "File Name", + "description": "The name of the file." + }, + "full_size_url": { + "type": "string", + "title": "File URL", + "description": "The url of the full-size file.", + "format": "uri", + "readOnly": true + }, + "thumbnail_url": { + "type": "string", + "title": "Thumbnail URL", + "description": "The url of the thumbnail preview.", + "format": "uri", + "readOnly": true + }, + "size": { + "type": "integer", + "title": "File Size", + "description": "The size of the file in bytes.", + "readOnly": true + }, + "created_at": { + "type": "string", + "title": "Created Date", + "description": "The date and time a file was added to the File Manager in ISO 8601 format.", + "format": "date-time", + "readOnly": true + }, + "created_by": { + "type": "string", + "title": "Created By", + "description": "The username of the profile that uploaded the file.", + "readOnly": true + }, + "width": { + "type": "integer", + "title": "Image Width", + "description": "The width of the image.", + "readOnly": true + }, + "height": { + "type": "integer", + "title": "Image Height", + "description": "The height of an image.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + }, + "title": "Files", + "description": " A list of files and images in an account." + }, + "total_file_size": { + "type": "number", + "title": "Total File Size", + "description": "The total size of all File Manager files in bytes.", + "readOnly": true + }, + "total_items": { + "type": "integer", + "title": "Item Count", + "description": "The total number of items matching the query regardless of pagination.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "fileManager" + ], + "x-custom-config": { + "methodNameSnake": "folders_files", + "methodNameCamel": "foldersFiles" + } + } + }, + "/lists": { + "get": { + "summary": "Get lists info", + "description": "Get information about all lists in the account.", + "operationId": "getLists", "parameters": [ { "name": "fields", @@ -53625,6 +54850,12 @@ "description": "The MD5 hash of the lowercase version of the list member's email address.", "readOnly": true }, + "contact_id": { + "type": "string", + "title": "Contact ID", + "description": "A unique ID for the contact record.", + "readOnly": true + }, "email_address": { "type": "string", "title": "Email Address", @@ -53925,6 +55156,12 @@ "description": "The MD5 hash of the lowercase version of the list member's email address.", "readOnly": true }, + "contact_id": { + "type": "string", + "title": "Contact ID", + "description": "A unique ID for the contact record.", + "readOnly": true + }, "email_address": { "type": "string", "title": "Email Address", @@ -70576,304 +71813,316 @@ "description": "The MD5 hash of the lowercase version of the list member's email address.", "readOnly": true }, - "email_address": { - "type": "string", - "title": "Email Address", - "description": "Email address for a subscriber." - }, - "unique_email_id": { - "type": "string", - "title": "Unique Email ID", - "description": "An identifier for the address across all of Mailchimp.", - "readOnly": true - }, - "email_type": { - "type": "string", - "title": "Email Type", - "description": "Type of email this member asked to get ('html' or 'text')." - }, - "status": { - "type": "string", - "title": "Status", - "description": "Subscriber's current status.", - "enum": [ - "subscribed", - "unsubscribed", - "cleaned", - "pending", - "transactional" - ] - }, - "merge_fields": { - "type": "object", - "title": "Member Merge Var", - "description": "An individual merge var and value for a member.", - "additionalProperties": { - "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." - } - }, - "interests": { - "type": "object", - "title": "Subscriber Interests", - "description": "The key of this object's properties is the ID of the interest in question.", - "additionalProperties": { - "type": "boolean", - "title": "Interest Value", - "description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not." - } - }, - "stats": { - "type": "object", - "title": "Subscriber Stats", - "description": "Open and click rates for this subscriber.", - "readOnly": true, - "properties": { - "avg_open_rate": { - "type": "number", - "title": "Average Open Rate", - "description": "A subscriber's average open rate.", - "readOnly": true - }, - "avg_click_rate": { - "type": "number", - "title": "Average Click Rate", - "description": "A subscriber's average clickthrough rate.", - "readOnly": true - } - } - }, - "ip_signup": { - "type": "string", - "title": "Signup IP", - "description": "IP address the subscriber signed up from.", - "readOnly": true - }, - "timestamp_signup": { - "type": "string", - "title": "Signup Timestamp", - "description": "The date and time the subscriber signed up for the list in ISO 8601 format.", - "format": "date-time", - "readOnly": true - }, - "ip_opt": { - "type": "string", - "title": "Opt-in IP", - "description": "The IP address the subscriber used to confirm their opt-in status.", - "readOnly": true - }, - "timestamp_opt": { - "type": "string", - "title": "Opt-in Timestamp", - "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.", - "readOnly": true, - "format": "date-time" - }, - "member_rating": { - "type": "integer", - "title": "Member Rating", - "description": "Star rating for this member, between 1 and 5.", - "readOnly": true - }, - "last_changed": { - "type": "string", - "title": "Last Changed Date", - "description": "The date and time the member's info was last changed in ISO 8601 format.", - "readOnly": true, - "format": "date-time" - }, - "language": { - "type": "string", - "title": "Language", - "description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)." - }, - "vip": { - "type": "boolean", - "title": "VIP", - "description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." - }, - "email_client": { - "type": "string", - "title": "Email Client", - "description": "The list member's email client.", - "readOnly": true - }, - "location": { - "type": "object", - "title": "Location", - "description": "Subscriber location information.", - "properties": { - "latitude": { - "type": "number", - "title": "Latitude", - "description": "The location latitude." - }, - "longitude": { - "type": "number", - "title": "Longitude", - "description": "The location longitude." - }, - "gmtoff": { - "type": "integer", - "title": "GMT Offset", - "description": "The time difference in hours from GMT.", - "readOnly": true - }, - "dstoff": { - "type": "integer", - "title": "DST Offset", - "description": "The offset for timezones where daylight saving time is observed.", - "readOnly": true - }, - "country_code": { - "type": "string", - "title": "Country Code", - "description": "The unique code for the location country.", - "readOnly": true - }, - "timezone": { - "type": "string", - "title": "Timezone", - "description": "The timezone for the location.", - "readOnly": true - } - } - }, - "last_note": { - "type": "object", - "title": "Notes", - "description": "The most recent Note added about this member.", - "readOnly": true, - "properties": { - "note_id": { - "type": "integer", - "title": "Note ID", - "description": "The note id.", - "readOnly": true - }, - "created_at": { - "type": "string", - "title": "Created Time", - "description": "The date and time the note was created in ISO 8601 format.", - "format": "date-time", - "readOnly": true - }, - "created_by": { - "type": "string", - "title": "Author", - "description": "The author of the note.", - "readOnly": true - }, - "note": { - "type": "string", - "title": "Note", - "description": "The content of the note.", - "readOnly": true - } - } - }, - "tags_count": { - "type": "integer", - "title": "Tags Count", - "description": "The number of tags applied to this member.", - "readOnly": true - }, - "tags": { - "type": "array", - "title": "Tags", - "description": "The tags applied to this member.", - "readOnly": false, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "title": "Tag ID", - "description": "The tag id.", - "readOnly": true - }, - "name": { - "type": "string", - "title": "Tag Name", - "description": "The name of the tag", - "readOnly": true - } - } - } - }, - "list_id": { - "type": "string", - "title": "List ID", - "description": "The list id.", - "readOnly": true - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "members_removed": { - "type": "array", - "title": "Members Removed", - "description": "An array of objects, each representing an existing list member that got deleted from the static segment.", - "items": { - "type": "object", - "title": "List Members", - "description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.", - "properties": { - "id": { + "contact_id": { "type": "string", - "title": "Email ID", - "description": "The MD5 hash of the lowercase version of the list member's email address.", + "title": "Contact ID", + "description": "A unique ID for the contact record.", + "readOnly": true + }, + "email_address": { + "type": "string", + "title": "Email Address", + "description": "Email address for a subscriber." + }, + "unique_email_id": { + "type": "string", + "title": "Unique Email ID", + "description": "An identifier for the address across all of Mailchimp.", + "readOnly": true + }, + "email_type": { + "type": "string", + "title": "Email Type", + "description": "Type of email this member asked to get ('html' or 'text')." + }, + "status": { + "type": "string", + "title": "Status", + "description": "Subscriber's current status.", + "enum": [ + "subscribed", + "unsubscribed", + "cleaned", + "pending", + "transactional" + ] + }, + "merge_fields": { + "type": "object", + "title": "Member Merge Var", + "description": "An individual merge var and value for a member.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "interests": { + "type": "object", + "title": "Subscriber Interests", + "description": "The key of this object's properties is the ID of the interest in question.", + "additionalProperties": { + "type": "boolean", + "title": "Interest Value", + "description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not." + } + }, + "stats": { + "type": "object", + "title": "Subscriber Stats", + "description": "Open and click rates for this subscriber.", + "readOnly": true, + "properties": { + "avg_open_rate": { + "type": "number", + "title": "Average Open Rate", + "description": "A subscriber's average open rate.", + "readOnly": true + }, + "avg_click_rate": { + "type": "number", + "title": "Average Click Rate", + "description": "A subscriber's average clickthrough rate.", + "readOnly": true + } + } + }, + "ip_signup": { + "type": "string", + "title": "Signup IP", + "description": "IP address the subscriber signed up from.", + "readOnly": true + }, + "timestamp_signup": { + "type": "string", + "title": "Signup Timestamp", + "description": "The date and time the subscriber signed up for the list in ISO 8601 format.", + "format": "date-time", + "readOnly": true + }, + "ip_opt": { + "type": "string", + "title": "Opt-in IP", + "description": "The IP address the subscriber used to confirm their opt-in status.", + "readOnly": true + }, + "timestamp_opt": { + "type": "string", + "title": "Opt-in Timestamp", + "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.", + "readOnly": true, + "format": "date-time" + }, + "member_rating": { + "type": "integer", + "title": "Member Rating", + "description": "Star rating for this member, between 1 and 5.", + "readOnly": true + }, + "last_changed": { + "type": "string", + "title": "Last Changed Date", + "description": "The date and time the member's info was last changed in ISO 8601 format.", + "readOnly": true, + "format": "date-time" + }, + "language": { + "type": "string", + "title": "Language", + "description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)." + }, + "vip": { + "type": "boolean", + "title": "VIP", + "description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." + }, + "email_client": { + "type": "string", + "title": "Email Client", + "description": "The list member's email client.", + "readOnly": true + }, + "location": { + "type": "object", + "title": "Location", + "description": "Subscriber location information.", + "properties": { + "latitude": { + "type": "number", + "title": "Latitude", + "description": "The location latitude." + }, + "longitude": { + "type": "number", + "title": "Longitude", + "description": "The location longitude." + }, + "gmtoff": { + "type": "integer", + "title": "GMT Offset", + "description": "The time difference in hours from GMT.", + "readOnly": true + }, + "dstoff": { + "type": "integer", + "title": "DST Offset", + "description": "The offset for timezones where daylight saving time is observed.", + "readOnly": true + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The unique code for the location country.", + "readOnly": true + }, + "timezone": { + "type": "string", + "title": "Timezone", + "description": "The timezone for the location.", + "readOnly": true + } + } + }, + "last_note": { + "type": "object", + "title": "Notes", + "description": "The most recent Note added about this member.", + "readOnly": true, + "properties": { + "note_id": { + "type": "integer", + "title": "Note ID", + "description": "The note id.", + "readOnly": true + }, + "created_at": { + "type": "string", + "title": "Created Time", + "description": "The date and time the note was created in ISO 8601 format.", + "format": "date-time", + "readOnly": true + }, + "created_by": { + "type": "string", + "title": "Author", + "description": "The author of the note.", + "readOnly": true + }, + "note": { + "type": "string", + "title": "Note", + "description": "The content of the note.", + "readOnly": true + } + } + }, + "tags_count": { + "type": "integer", + "title": "Tags Count", + "description": "The number of tags applied to this member.", + "readOnly": true + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "The tags applied to this member.", + "readOnly": false, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Tag ID", + "description": "The tag id.", + "readOnly": true + }, + "name": { + "type": "string", + "title": "Tag Name", + "description": "The name of the tag", + "readOnly": true + } + } + } + }, + "list_id": { + "type": "string", + "title": "List ID", + "description": "The list id.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "members_removed": { + "type": "array", + "title": "Members Removed", + "description": "An array of objects, each representing an existing list member that got deleted from the static segment.", + "items": { + "type": "object", + "title": "List Members", + "description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.", + "properties": { + "id": { + "type": "string", + "title": "Email ID", + "description": "The MD5 hash of the lowercase version of the list member's email address.", + "readOnly": true + }, + "contact_id": { + "type": "string", + "title": "Contact ID", + "description": "A unique ID for the contact record.", "readOnly": true }, "email_address": { @@ -71435,6 +72684,12 @@ "description": "Email address for a subscriber.", "readOnly": true }, + "full_name": { + "type": "string", + "title": "Full Name", + "description": "The contact's full name.", + "readOnly": true + }, "unique_email_id": { "type": "string", "title": "Unique Email ID", @@ -71867,6 +73122,12 @@ "description": "Email address for a subscriber.", "readOnly": true }, + "full_name": { + "type": "string", + "title": "Full Name", + "description": "The contact's full name.", + "readOnly": true + }, "unique_email_id": { "type": "string", "title": "Unique Email ID", @@ -72667,6 +73928,27 @@ "description": "Indicates whether a contact consents to 1:1 messaging.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, + "sms_subscription_status": { + "type": "string", + "title": "SMS Subscription Status", + "description": "The status of an SMS subscription.", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ] + }, + "sms_subscription_last_updated": { + "type": "string", + "title": "SMS Subscription Last Update", + "description": "The datetime when the SMS subscription was last updated" + }, "merge_fields": { "type": "object", "title": "Merge Fields", @@ -73346,505 +74628,547 @@ "description": "Indicates whether a contact consents to 1:1 messaging.", "readOnly": true }, - "merge_fields": { - "type": "object", - "title": "Merge Fields", - "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", - "additionalProperties": { - "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." - } - }, - "interests": { - "type": "object", - "title": "Subscriber Interests", - "description": "The key of this object's properties is the ID of the interest in question.", - "additionalProperties": { - "type": "boolean", - "title": "Interest Value", - "description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not." - } - }, - "stats": { - "type": "object", - "title": "Subscriber Stats", - "description": "Open and click rates for this subscriber.", - "readOnly": true, - "properties": { - "avg_open_rate": { - "type": "number", - "title": "Average Open Rate", - "description": "A subscriber's average open rate.", - "readOnly": true - }, - "avg_click_rate": { - "type": "number", - "title": "Average Click Rate", - "description": "A subscriber's average clickthrough rate.", - "readOnly": true - }, - "ecommerce_data": { - "type": "object", - "title": "Ecommerce Stats", - "description": "Ecommerce stats for the list member if the list is attached to a store.", - "readOnly": true, - "properties": { - "total_revenue": { - "type": "number", - "title": "Total Revenue", - "description": "The total revenue the list member has brought in.", - "readOnly": true - }, - "number_of_orders": { - "type": "number", - "title": "Total Number of Orders", - "description": "The total number of orders placed by the list member.", - "readOnly": true - }, - "currency_code": { - "type": "string", - "title": "Currency", - "description": "The three-letter ISO 4217 code for the currency that the store accepts.", - "readOnly": true, - "example": "USD" - } - } - } - } - }, - "ip_signup": { - "type": "string", - "title": "Signup IP", - "description": "IP address the subscriber signed up from.", - "readOnly": true - }, - "timestamp_signup": { - "type": "string", - "title": "Signup Timestamp", - "description": "The date and time the subscriber signed up for the list in ISO 8601 format.", - "format": "date-time", - "readOnly": true - }, - "ip_opt": { - "type": "string", - "title": "Opt-in IP", - "description": "The IP address the subscriber used to confirm their opt-in status.", - "readOnly": true - }, - "timestamp_opt": { - "type": "string", - "title": "Opt-in Timestamp", - "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.", - "readOnly": true, - "format": "date-time" - }, - "member_rating": { - "type": "integer", - "title": "Member Rating", - "description": "Star rating for this member, between 1 and 5.", - "readOnly": true - }, - "last_changed": { - "type": "string", - "title": "Last Changed Date", - "description": "The date and time the member's info was last changed in ISO 8601 format.", - "readOnly": true, - "format": "date-time" - }, - "language": { - "type": "string", - "title": "Language", - "description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)." - }, - "vip": { - "type": "boolean", - "title": "VIP", - "description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." - }, - "email_client": { + "sms_phone_number": { "type": "string", - "title": "Email Client", - "description": "The list member's email client.", - "readOnly": true - }, - "location": { - "type": "object", - "title": "Location", - "description": "Subscriber location information.", - "properties": { - "latitude": { - "type": "number", - "title": "Latitude", - "description": "The location latitude." - }, - "longitude": { - "type": "number", - "title": "Longitude", - "description": "The location longitude." - }, - "gmtoff": { - "type": "integer", - "title": "GMT Offset", - "description": "The time difference in hours from GMT.", - "readOnly": true - }, - "dstoff": { - "type": "integer", - "title": "DST Offset", - "description": "The offset for timezones where daylight saving time is observed.", - "readOnly": true - }, - "country_code": { - "type": "string", - "title": "Country Code", - "description": "The unique code for the location country.", - "readOnly": true - }, - "timezone": { - "type": "string", - "title": "Timezone", - "description": "The timezone for the location.", - "readOnly": true - }, - "region": { - "type": "string", - "title": "Region", - "description": "The region for the location.", - "readOnly": true - } - } + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." }, - "marketing_permissions": { - "type": "array", - "title": "Marketing Permissions", - "description": "The marketing permissions for the subscriber.", - "items": { - "type": "object", - "title": "Marketing Permission", - "description": "A single marketing permission a subscriber has either opted-in to or opted-out of.", - "properties": { - "marketing_permission_id": { - "type": "string", - "title": "Marketing Permission ID", - "description": "The id for the marketing permission on the list" - }, - "text": { - "type": "string", - "title": "Marketing Permission Text", - "description": "The text of the marketing permission." - }, - "enabled": { - "type": "boolean", - "title": "Enabled", - "description": "If the subscriber has opted-in to the marketing permission." - } - } - } - }, - "last_note": { - "type": "object", - "title": "Notes", - "description": "The most recent Note added about this member.", - "readOnly": true, - "properties": { - "note_id": { - "type": "integer", - "title": "Note ID", - "description": "The note id.", - "readOnly": true - }, - "created_at": { - "type": "string", - "title": "Created Time", - "description": "The date and time the note was created in ISO 8601 format.", - "format": "date-time", - "readOnly": true - }, - "created_by": { - "type": "string", - "title": "Author", - "description": "The author of the note.", - "readOnly": true - }, - "note": { - "type": "string", - "title": "Note", - "description": "The content of the note.", - "readOnly": true - } - } - }, - "source": { + "sms_subscription_status": { "type": "string", - "title": "Subscriber Source", - "description": "The source from which the subscriber was added to this list.", - "readOnly": true - }, - "tags_count": { - "type": "integer", - "title": "Tags Count", - "description": "The number of tags applied to this member.", - "readOnly": true - }, - "tags": { - "type": "array", - "title": "Tags", - "description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/).", - "readOnly": false, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "title": "Tag ID", - "description": "The tag id.", - "readOnly": true - }, - "name": { - "type": "string", - "title": "Tag Name", - "description": "The name of the tag", - "readOnly": true - } - } - } - }, - "list_id": { - "type": "string", - "title": "List ID", - "description": "The list id.", - "readOnly": true - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "default": { - "description": "An error generated by the Mailchimp API.", - "schema": { - "type": "object", - "title": "Problem Detail Document", - "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", - "required": [ - "type", - "title", - "status", - "detail", - "instance" - ], - "properties": { - "type": { - "type": "string", - "title": "Problem Type", - "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", - "example": "https://mailchimp.com/developer/marketing/docs/errors/" - }, - "title": { - "type": "string", - "title": "Error Title", - "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", - "example": "Resource Not Found" - }, - "status": { - "type": "integer", - "title": "HTTP Status Code", - "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", - "example": 404 - }, - "detail": { - "type": "string", - "title": "Error Message", - "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", - "example": "The requested resource could not be found." - }, - "instance": { - "type": "string", - "title": "Instance ID", - "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", - "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" - } - } - } - } - }, - "deprecated": false, - "tags": [ - "lists" - ], - "x-custom-config": { - "methodNameSnake": "add_list_member", - "methodNameCamel": "addListMember" - } - } - }, - "/lists/{list_id}/members/{subscriber_hash}": { - "get": { - "summary": "Get member info", - "description": "Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.", - "operationId": "getListsIdMembersId", - "parameters": [ - { - "name": "fields", - "x-title": "Fields", - "in": "query", - "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "exclude_fields", - "x-title": "Exclude Fields", - "in": "query", - "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "list_id", - "x-title": "List ID", - "in": "path", - "description": "The unique ID for the list.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "subscriber_hash", - "x-title": "Subscriber Hash", - "type": "string", - "required": true, - "description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id." - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "type": "object", - "title": "List Members", - "description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.", - "properties": { - "id": { - "type": "string", - "title": "Email ID", - "description": "The MD5 hash of the lowercase version of the list member's email address.", - "readOnly": true - }, - "email_address": { - "type": "string", - "title": "Email Address", - "description": "Email address for a subscriber." - }, - "unique_email_id": { - "type": "string", - "title": "Unique Email ID", - "description": "An identifier for the address across all of Mailchimp.", - "readOnly": true - }, - "contact_id": { - "type": "string", - "title": "Contact ID", - "description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact\u2019s inclusion of an email address.", - "readOnly": true - }, - "full_name": { - "type": "string", - "title": "Full Name", - "description": "The contact's full name.", - "readOnly": true - }, - "web_id": { - "type": "integer", - "title": "Member Web ID", - "description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`.", - "readOnly": true - }, - "email_type": { - "type": "string", - "title": "Email Type", - "description": "Type of email this member asked to get ('html' or 'text')." - }, - "status": { - "type": "string", - "title": "Status", - "description": "Subscriber's current status.", + "title": "SMS Subscription Status", + "description": "The status of an SMS subscription.", "enum": [ "subscribed", "unsubscribed", - "cleaned", - "pending", - "transactional", - "archived" + "nonsubscribed", + "pending" ] }, - "unsubscribe_reason": { + "sms_subscription_last_updated": { "type": "string", - "title": "Unsubscribe Reason", - "description": "A subscriber's reason for unsubscribing." - }, - "consents_to_one_to_one_messaging": { - "type": "boolean", - "title": "Messaging Consent", - "description": "Indicates whether a contact consents to 1:1 messaging.", - "readOnly": true + "title": "SMS Subscription Last Update", + "description": "The datetime when the SMS subscription was last updated" + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "interests": { + "type": "object", + "title": "Subscriber Interests", + "description": "The key of this object's properties is the ID of the interest in question.", + "additionalProperties": { + "type": "boolean", + "title": "Interest Value", + "description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not." + } + }, + "stats": { + "type": "object", + "title": "Subscriber Stats", + "description": "Open and click rates for this subscriber.", + "readOnly": true, + "properties": { + "avg_open_rate": { + "type": "number", + "title": "Average Open Rate", + "description": "A subscriber's average open rate.", + "readOnly": true + }, + "avg_click_rate": { + "type": "number", + "title": "Average Click Rate", + "description": "A subscriber's average clickthrough rate.", + "readOnly": true + }, + "ecommerce_data": { + "type": "object", + "title": "Ecommerce Stats", + "description": "Ecommerce stats for the list member if the list is attached to a store.", + "readOnly": true, + "properties": { + "total_revenue": { + "type": "number", + "title": "Total Revenue", + "description": "The total revenue the list member has brought in.", + "readOnly": true + }, + "number_of_orders": { + "type": "number", + "title": "Total Number of Orders", + "description": "The total number of orders placed by the list member.", + "readOnly": true + }, + "currency_code": { + "type": "string", + "title": "Currency", + "description": "The three-letter ISO 4217 code for the currency that the store accepts.", + "readOnly": true, + "example": "USD" + } + } + } + } + }, + "ip_signup": { + "type": "string", + "title": "Signup IP", + "description": "IP address the subscriber signed up from.", + "readOnly": true + }, + "timestamp_signup": { + "type": "string", + "title": "Signup Timestamp", + "description": "The date and time the subscriber signed up for the list in ISO 8601 format.", + "format": "date-time", + "readOnly": true + }, + "ip_opt": { + "type": "string", + "title": "Opt-in IP", + "description": "The IP address the subscriber used to confirm their opt-in status.", + "readOnly": true + }, + "timestamp_opt": { + "type": "string", + "title": "Opt-in Timestamp", + "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.", + "readOnly": true, + "format": "date-time" + }, + "member_rating": { + "type": "integer", + "title": "Member Rating", + "description": "Star rating for this member, between 1 and 5.", + "readOnly": true + }, + "last_changed": { + "type": "string", + "title": "Last Changed Date", + "description": "The date and time the member's info was last changed in ISO 8601 format.", + "readOnly": true, + "format": "date-time" + }, + "language": { + "type": "string", + "title": "Language", + "description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)." + }, + "vip": { + "type": "boolean", + "title": "VIP", + "description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." + }, + "email_client": { + "type": "string", + "title": "Email Client", + "description": "The list member's email client.", + "readOnly": true + }, + "location": { + "type": "object", + "title": "Location", + "description": "Subscriber location information.", + "properties": { + "latitude": { + "type": "number", + "title": "Latitude", + "description": "The location latitude." + }, + "longitude": { + "type": "number", + "title": "Longitude", + "description": "The location longitude." + }, + "gmtoff": { + "type": "integer", + "title": "GMT Offset", + "description": "The time difference in hours from GMT.", + "readOnly": true + }, + "dstoff": { + "type": "integer", + "title": "DST Offset", + "description": "The offset for timezones where daylight saving time is observed.", + "readOnly": true + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The unique code for the location country.", + "readOnly": true + }, + "timezone": { + "type": "string", + "title": "Timezone", + "description": "The timezone for the location.", + "readOnly": true + }, + "region": { + "type": "string", + "title": "Region", + "description": "The region for the location.", + "readOnly": true + } + } + }, + "marketing_permissions": { + "type": "array", + "title": "Marketing Permissions", + "description": "The marketing permissions for the subscriber.", + "items": { + "type": "object", + "title": "Marketing Permission", + "description": "A single marketing permission a subscriber has either opted-in to or opted-out of.", + "properties": { + "marketing_permission_id": { + "type": "string", + "title": "Marketing Permission ID", + "description": "The id for the marketing permission on the list" + }, + "text": { + "type": "string", + "title": "Marketing Permission Text", + "description": "The text of the marketing permission." + }, + "enabled": { + "type": "boolean", + "title": "Enabled", + "description": "If the subscriber has opted-in to the marketing permission." + } + } + } + }, + "last_note": { + "type": "object", + "title": "Notes", + "description": "The most recent Note added about this member.", + "readOnly": true, + "properties": { + "note_id": { + "type": "integer", + "title": "Note ID", + "description": "The note id.", + "readOnly": true + }, + "created_at": { + "type": "string", + "title": "Created Time", + "description": "The date and time the note was created in ISO 8601 format.", + "format": "date-time", + "readOnly": true + }, + "created_by": { + "type": "string", + "title": "Author", + "description": "The author of the note.", + "readOnly": true + }, + "note": { + "type": "string", + "title": "Note", + "description": "The content of the note.", + "readOnly": true + } + } + }, + "source": { + "type": "string", + "title": "Subscriber Source", + "description": "The source from which the subscriber was added to this list.", + "readOnly": true + }, + "tags_count": { + "type": "integer", + "title": "Tags Count", + "description": "The number of tags applied to this member.", + "readOnly": true + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/).", + "readOnly": false, + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Tag ID", + "description": "The tag id.", + "readOnly": true + }, + "name": { + "type": "string", + "title": "Tag Name", + "description": "The name of the tag", + "readOnly": true + } + } + } + }, + "list_id": { + "type": "string", + "title": "List ID", + "description": "The list id.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "lists" + ], + "x-custom-config": { + "methodNameSnake": "add_list_member", + "methodNameCamel": "addListMember" + } + } + }, + "/lists/{list_id}/members/{subscriber_hash}": { + "get": { + "summary": "Get member info", + "description": "Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.", + "operationId": "getListsIdMembersId", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "list_id", + "x-title": "List ID", + "in": "path", + "description": "The unique ID for the list.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscriber_hash", + "x-title": "Subscriber Hash", + "type": "string", + "required": true, + "description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id." + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "List Members", + "description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.", + "properties": { + "id": { + "type": "string", + "title": "Email ID", + "description": "The MD5 hash of the lowercase version of the list member's email address.", + "readOnly": true + }, + "email_address": { + "type": "string", + "title": "Email Address", + "description": "Email address for a subscriber." + }, + "unique_email_id": { + "type": "string", + "title": "Unique Email ID", + "description": "An identifier for the address across all of Mailchimp.", + "readOnly": true + }, + "contact_id": { + "type": "string", + "title": "Contact ID", + "description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact\u2019s inclusion of an email address.", + "readOnly": true + }, + "full_name": { + "type": "string", + "title": "Full Name", + "description": "The contact's full name.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Member Web ID", + "description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`.", + "readOnly": true + }, + "email_type": { + "type": "string", + "title": "Email Type", + "description": "Type of email this member asked to get ('html' or 'text')." + }, + "status": { + "type": "string", + "title": "Status", + "description": "Subscriber's current status.", + "enum": [ + "subscribed", + "unsubscribed", + "cleaned", + "pending", + "transactional", + "archived" + ] + }, + "unsubscribe_reason": { + "type": "string", + "title": "Unsubscribe Reason", + "description": "A subscriber's reason for unsubscribing." + }, + "consents_to_one_to_one_messaging": { + "type": "boolean", + "title": "Messaging Consent", + "description": "Indicates whether a contact consents to 1:1 messaging.", + "readOnly": true + }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, + "sms_subscription_status": { + "type": "string", + "title": "SMS Subscription Status", + "description": "The status of an SMS subscription.", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ] + }, + "sms_subscription_last_updated": { + "type": "string", + "title": "SMS Subscription Last Update", + "description": "The datetime when the SMS subscription was last updated" }, "merge_fields": { "type": "object", @@ -74468,6 +75792,27 @@ "description": "Indicates whether a contact consents to 1:1 messaging.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, + "sms_subscription_status": { + "type": "string", + "title": "SMS Subscription Status", + "description": "The status of an SMS subscription.", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ] + }, + "sms_subscription_last_updated": { + "type": "string", + "title": "SMS Subscription Last Update", + "description": "The datetime when the SMS subscription was last updated" + }, "merge_fields": { "type": "object", "title": "Merge Fields", @@ -75073,6 +76418,27 @@ "description": "Indicates whether a contact consents to 1:1 messaging.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, + "sms_subscription_status": { + "type": "string", + "title": "SMS Subscription Status", + "description": "The status of an SMS subscription.", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ] + }, + "sms_subscription_last_updated": { + "type": "string", + "title": "SMS Subscription Last Update", + "description": "The datetime when the SMS subscription was last updated" + }, "merge_fields": { "type": "object", "title": "Merge Fields", @@ -75590,32 +76956,18 @@ "type": "array", "required": false, "items": { - "type": "string" - }, - "collectionFormat": "csv", - "enum": [ - [ - "abuse" - ], - [ - "bounce" - ], - [ - "click" - ], - [ - "open" - ], - [ - "sent" - ], - [ - "unsub" - ], - [ + "type": "string", + "enum": [ + "abuse", + "bounce", + "click", + "open", + "sent", + "unsub", "ecomm" ] - ], + }, + "collectionFormat": "csv", "description": "A comma seperated list of actions to return." } ], @@ -75832,7 +77184,7 @@ "x-title": "Subscriber Hash", "type": "string", "required": true, - "description": "The MD5 hash of the lowercase version of the list member's email address." + "description": "The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id." }, { "name": "fields", @@ -75884,68 +77236,34 @@ "type": "array", "required": false, "items": { - "type": "string" + "type": "string", + "enum": [ + "bounce", + "click", + "conversation", + "ecommerce_signup", + "event", + "web_engagement", + "generic_signup", + "landing_page_signup", + "marketing_permission", + "note", + "open", + "order", + "postcard_sent", + "sent", + "signup", + "squatter_signup", + "unsub", + "website_signup", + "survey_response", + "sms_bulk_sent", + "inbox_thread", + "qbo_payment_link", + "video_call_transcripts" + ] }, "collectionFormat": "csv", - "enum": [ - [ - "bounce" - ], - [ - "click" - ], - [ - "conversation" - ], - [ - "ecommerce_signup" - ], - [ - "event" - ], - [ - "web_engagement" - ], - [ - "generic_signup" - ], - [ - "landing_page_signup" - ], - [ - "marketing_permission" - ], - [ - "note" - ], - [ - "open" - ], - [ - "order" - ], - [ - "postcard_sent" - ], - [ - "sent" - ], - [ - "signup" - ], - [ - "squatter_signup" - ], - [ - "unsub" - ], - [ - "website_signup" - ], - [ - "survey_response" - ] - ], "description": "A comma-separated list of activity filters that correspond to a set of activity types, e.g \"?activity_filters=open,bounce,click\"." } ], @@ -76285,7 +77603,7 @@ "format": "date-time", "description": "The created at timestamp in ISO8601." }, - "marketing_permisson_text": { + "marketing_permission_text": { "type": "string", "title": "Marketing Permission Text", "description": "The text describing this marketing permission." @@ -76644,6 +77962,11 @@ "type": "string", "title": "Order URL", "description": "The order URL." + }, + "integration_platform": { + "type": "string", + "title": "Integration Platform", + "description": "The name of the integration platform this order originated through." } } }, @@ -76712,6 +78035,164 @@ "description": "The title of the survey." } } + }, + { + "type": "object", + "title": "SMS Bulk Sent", + "description": "Activity feed item representing an SMS campaign sent to the contact.", + "properties": { + "activity_type": { + "type": "string", + "description": "The type of event activity.", + "x-value": "sms_bulk_sent", + "enum": [ + "sms_bulk_sent" + ] + }, + "created_at_timestamp": { + "type": "string", + "title": "Created At Timestamp", + "format": "date-time", + "description": "The created at timestamp in ISO8601." + }, + "campaign_id": { + "type": "string", + "title": "Campaign ID", + "description": "The campaign's unique id." + }, + "campaign_title": { + "type": "string", + "title": "Campaign Title", + "description": "The title of the SMS campaign." + } + } + }, + { + "type": "object", + "title": "Inbox Thread", + "description": "Activity feed item representing a thread located in Inbox.", + "properties": { + "activity_type": { + "type": "string", + "description": "The type of event activity.", + "x-value": "inbox_thread", + "enum": [ + "inbox_thread" + ] + }, + "created_at_timestamp": { + "type": "string", + "title": "Created At Timestamp", + "format": "date-time", + "description": "The created at timestamp in ISO8601." + }, + "id": { + "type": "string", + "title": "Thread ID", + "description": "The ID of the thread." + }, + "thread_subject": { + "type": "string", + "title": "Thread Subject", + "description": "The subject of the thread." + }, + "thread_url": { + "type": "string", + "title": "Thread URL", + "description": "The url of the thread." + }, + "thread_direction": { + "type": "string", + "title": "Thread Direction", + "description": "The direction of the message noting if it is outbound or inbound.", + "enum": [ + "INBOUND", + "OUTBOUND" + ] + }, + "thread_author": { + "type": "string", + "title": "Thread Author", + "description": "The author of the thread." + } + } + }, + { + "type": "object", + "title": "QBO Payment Link", + "description": "Activity feed item representing a payment link from QBO.", + "properties": { + "activity_type": { + "type": "string", + "description": "The type of event activity.", + "x-value": "qbo_payment_link", + "enum": [ + "qbo_payment_link" + ] + }, + "created_at_timestamp": { + "type": "string", + "title": "Created At Timestamp", + "format": "date-time", + "description": "The created at timestamp in ISO8601." + }, + "id": { + "type": "string", + "title": "id", + "description": "The QuickBooks payment link id." + }, + "qbo_payment_external_id": { + "type": "string", + "title": "QBO Payment External ID", + "description": "The external QuickBooks payment id." + }, + "integration_platform": { + "type": "string", + "title": "Integration Platform", + "description": "The platform Mailchimp is integrated with.", + "enum": [ + "quickbooks" + ] + } + } + }, + { + "type": "object", + "title": "Video Call Transcripts", + "description": "Activity feed item representing a video call transcript.", + "properties": { + "activity_type": { + "type": "string", + "description": "The type of event activity.", + "x-value": "video_call_transcripts", + "enum": [ + "video_call_transcripts" + ] + }, + "created_at_timestamp": { + "type": "string", + "title": "Created At Timestamp", + "format": "date-time", + "description": "The created at timestamp in ISO8601." + }, + "id": { + "type": "string", + "title": "id", + "description": "The id for video call transcripts." + }, + "scheduled_meeting_start_timestamp": { + "type": "string", + "title": "Scheduled Meeting Start Timestamp", + "format": "date-time", + "description": "The Scheduled Meeting Start timestamp in ISO8601." + }, + "expire_at_timestamp": { + "type": "string", + "title": "Expire At Timestamp", + "format": "date-time", + "description": "The Expire At timestamp in ISO8601." + } + } } ] } @@ -83070,863 +84551,3686 @@ "operationId": "postListsIdSurveysIdActionsUnpublish" } }, - "/landing-pages": { - "get": { - "description": "Get all landing pages.", - "operationId": "getAllLandingPages", + "/lists/{list_id}/surveys/{survey_id}/actions/create-email": { + "post": { + "summary": "Create a Survey Campaign", + "description": "Utilize the List ID and Survey ID to generate a Campaign that links to your survey.", "parameters": [ { - "name": "sort_dir", - "x-title": "Sort Direction", - "description": "Determines the order direction for sorted results.", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "ASC", - "DESC" - ] + "name": "list_id", + "x-title": "List ID", + "in": "path", + "description": "The unique ID for the list.", + "required": true, + "type": "string" }, { - "name": "sort_field", - "x-title": "Sort By Field", - "description": "Returns files sorted by the specified field.", - "in": "query", - "required": false, + "in": "path", + "name": "survey_id", + "x-title": "Survey ID", "type": "string", - "enum": [ - "created_at", - "updated_at" - ] - }, - { - "name": "fields", - "x-title": "Fields", - "in": "query", - "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "exclude_fields", - "x-title": "Exclude Fields", - "in": "query", - "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "count", - "x-title": "Count", - "in": "query", - "description": "The number of records to return. Default value is 10. Maximum value is 1000", - "required": false, - "default": 10, - "maximum": 1000, - "type": "integer" + "required": true, + "description": "The ID of the survey." } ], "responses": { "200": { - "description": "Landing Pages Collection", - "schema": { - "type": "object", - "description": "A collection of landing pages.", - "properties": { - "landing_pages": { - "type": "array", - "description": "The landing pages on the account", - "items": { - "type": "object", - "title": "Landing Page", - "description": "A summary of an individual landing page's settings and content.", - "properties": { - "id": { - "type": "string", - "title": "Landing Page ID", - "description": "A string that uniquely identifies this landing page.", - "readOnly": true, - "example": "030092c2e1f0" - }, - "name": { - "type": "string", - "title": "Landing Page Name", - "description": "The name of this landing page.", - "readOnly": false - }, - "title": { - "type": "string", - "title": "Landing Page title", - "description": "The title of this landing page seen in the browser's title bar.", - "readOnly": false - }, - "description": { - "type": "string", - "title": "Landing Page description", - "description": "The description of this landing page.", - "readOnly": false - }, - "template_id": { - "type": "integer", - "title": "Landing Page template_id", - "description": "The template_id of this landing page.", - "readOnly": true - }, - "status": { - "type": "string", - "title": "Landing Page status", - "description": "The status of this landing page.", - "enum": [ - "published", - "unpublished", - "draft" - ], - "readOnly": true - }, - "list_id": { - "type": "string", - "title": "Landing Page list id", - "description": "The list's ID associated with this landing page.", - "example": "fde02ad86b", - "readOnly": false - }, - "store_id": { - "type": "string", - "title": "Store ID", - "description": "The ID of the store associated with this landing page.", - "readOnly": false - }, - "web_id": { - "type": "integer", - "title": "Landing Page Web ID", - "description": "The ID used in the Mailchimp web application." - }, - "created_by_source": { - "type": "string", - "title": "Created By Source", - "description": "Created by mobile or web", - "readOnly": true - }, - "url": { - "type": "string", - "title": "Published url", - "description": "The url of the published landing page.", - "readOnly": true - }, - "created_at": { - "type": "string", - "title": "Created At", - "description": "The time this landing page was created.", - "format": "date-time", - "readOnly": true - }, - "published_at": { - "type": "string", - "title": "Published at", - "description": "The time this landing page was published.", - "format": "date-time", - "readOnly": true - }, - "unpublished_at": { - "type": "string", - "title": "Unpublished at", - "description": "The time this landing page was unpublished.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "title": "Updated_at", - "description": "The time this landing page was updated at.", - "format": "date-time", - "readOnly": true - }, - "tracking": { - "type": "object", - "title": "Tracking Settings", - "description": "The tracking settings applied to this landing page.", - "properties": { - "track_with_mailchimp": { - "type": "boolean", - "title": "Track with Mailchimp", - "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." - }, - "enable_restricted_data_processing": { - "type": "boolean", - "title": "Enable restricted data processing", - "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." - } - } - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "total_items": { - "type": "integer", - "title": "Item Count", - "description": "The total number of items matching the query regardless of pagination.", - "readOnly": true - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "default": { - "description": "An error generated by the Mailchimp API.", + "description": "Campaign Instance", "schema": { "type": "object", - "title": "Problem Detail Document", - "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "title": "Campaign", + "description": "A summary of an individual campaign's settings and content.", "required": [ - "type", - "title", - "status", - "detail", - "instance" + "type" ], - "properties": { - "type": { - "type": "string", - "title": "Problem Type", - "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", - "example": "https://mailchimp.com/developer/marketing/docs/errors/" - }, - "title": { - "type": "string", - "title": "Error Title", - "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", - "example": "Resource Not Found" - }, - "status": { - "type": "integer", - "title": "HTTP Status Code", - "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", - "example": 404 - }, - "detail": { - "type": "string", - "title": "Error Message", - "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", - "example": "The requested resource could not be found." - }, - "instance": { - "type": "string", - "title": "Instance ID", - "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", - "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" - } - } - } - } - }, - "tags": [ - "landingPages" - ], - "x-custom-config": { - "methodNameSnake": "get_all", - "methodNameCamel": "getAll" - }, - "summary": "List landing pages" - }, - "post": { - "summary": "Add landing page", - "description": "Create a new Mailchimp landing page.", - "parameters": [ - { - "name": "body", - "in": "body", - "description": "", - "required": true, - "schema": { - "type": "object", - "title": "Landing Page", - "description": "A summary of an individual page's properties.", - "properties": { - "name": { - "type": "string", - "title": "Landing Page Name", - "description": "The name of this landing page." - }, - "title": { - "type": "string", - "title": "Landing Page title", - "description": "The title of this landing page seen in the browser's title bar." - }, - "description": { - "type": "string", - "title": "Landing Page description", - "description": "The description of this landing page." - }, - "store_id": { - "type": "string", - "title": "Store ID", - "description": "The ID of the store associated with this landing page." - }, - "list_id": { - "type": "string", - "title": "Landing Page list id", - "description": "The list's ID associated with this landing page." - }, - "type": { - "type": "string", - "title": "Landing Page Template Type", - "description": "The type of template the landing page has.", - "enum": [ - "signup", - "product" - ], - "example": "signup" - }, - "template_id": { - "type": "integer", - "title": "Landing Page template_id", - "description": "The template_id of this landing page.", - "example": 1001 - }, - "tracking": { - "type": "object", - "title": "Tracking Settings", - "description": "The tracking settings applied to this landing page.", - "properties": { - "track_with_mailchimp": { - "type": "boolean", - "title": "Track with Mailchimp", - "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." - }, - "enable_restricted_data_processing": { - "type": "boolean", - "title": "Enable restricted data processing", - "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." - } - } - } - } - } - }, - { - "in": "query", - "name": "use_default_list", - "x-title": "Use Default List", - "type": "boolean", - "required": false, - "description": "Will create the Landing Page using the account's Default List instead of requiring a list_id." - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "type": "object", - "title": "Landing Page", - "description": "A summary of an individual landing page's settings and content.", "properties": { "id": { "type": "string", - "title": "Landing Page ID", - "description": "A string that uniquely identifies this landing page.", - "readOnly": true, - "example": "030092c2e1f0" - }, - "name": { - "type": "string", - "title": "Landing Page Name", - "description": "The name of this landing page.", - "readOnly": false - }, - "title": { - "type": "string", - "title": "Landing Page title", - "description": "The title of this landing page seen in the browser's title bar.", - "readOnly": false - }, - "description": { - "type": "string", - "title": "Landing Page description", - "description": "The description of this landing page.", - "readOnly": false - }, - "template_id": { - "type": "integer", - "title": "Landing Page template_id", - "description": "The template_id of this landing page.", - "readOnly": true - }, - "status": { - "type": "string", - "title": "Landing Page status", - "description": "The status of this landing page.", - "enum": [ - "published", - "unpublished", - "draft" - ], + "title": "Campaign ID", + "description": "A string that uniquely identifies this campaign.", "readOnly": true }, - "list_id": { - "type": "string", - "title": "Landing Page list id", - "description": "The list's ID associated with this landing page.", - "example": "fde02ad86b", - "readOnly": false - }, - "store_id": { - "type": "string", - "title": "Store ID", - "description": "The ID of the store associated with this landing page.", - "readOnly": false - }, "web_id": { "type": "integer", - "title": "Landing Page Web ID", - "description": "The ID used in the Mailchimp web application." - }, - "created_by_source": { - "type": "string", - "title": "Created By Source", - "description": "Created by mobile or web", - "readOnly": true - }, - "url": { - "type": "string", - "title": "Published url", - "description": "The url of the published landing page.", + "title": "Campaign Web ID", + "description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", "readOnly": true }, - "created_at": { + "parent_campaign_id": { "type": "string", - "title": "Created At", - "description": "The time this landing page was created.", - "format": "date-time", + "title": "Parent Campaign ID", + "description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children.", "readOnly": true }, - "published_at": { + "type": { "type": "string", - "title": "Published at", - "description": "The time this landing page was published.", - "format": "date-time", - "readOnly": true + "title": "Campaign Type", + "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" + ] }, - "unpublished_at": { + "create_time": { "type": "string", - "title": "Unpublished at", - "description": "The time this landing page was unpublished.", "format": "date-time", + "title": "Create Time", + "description": "The date and time the campaign was created in ISO 8601 format.", "readOnly": true }, - "updated_at": { + "archive_url": { "type": "string", - "title": "Updated_at", - "description": "The time this landing page was updated at.", - "format": "date-time", - "readOnly": true - }, - "tracking": { - "type": "object", - "title": "Tracking Settings", - "description": "The tracking settings applied to this landing page.", - "properties": { - "track_with_mailchimp": { - "type": "boolean", - "title": "Track with Mailchimp", - "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." - }, - "enable_restricted_data_processing": { - "type": "boolean", - "title": "Enable restricted data processing", - "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." - } - } - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, + "title": "Archive URL", + "description": "The link to the campaign's archive version.", "readOnly": true - } - } - } - }, - "default": { - "description": "An error generated by the Mailchimp API.", - "schema": { - "type": "object", - "title": "Problem Detail Document", - "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", - "required": [ - "type", - "title", - "status", - "detail", - "instance" - ], - "properties": { - "type": { - "type": "string", - "title": "Problem Type", - "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", - "example": "https://mailchimp.com/developer/marketing/docs/errors/" - }, - "title": { - "type": "string", - "title": "Error Title", - "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", - "example": "Resource Not Found" - }, - "status": { - "type": "integer", - "title": "HTTP Status Code", - "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", - "example": 404 - }, - "detail": { - "type": "string", - "title": "Error Message", - "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", - "example": "The requested resource could not be found." - }, - "instance": { - "type": "string", - "title": "Instance ID", - "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", - "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" - } - } - } - } - }, - "deprecated": false, - "tags": [ - "landingPages" - ], - "x-custom-config": { - "methodNameSnake": "create", - "methodNameCamel": "create" - }, - "operationId": "postAllLandingPages" - } - }, - "/landing-pages/{page_id}": { - "get": { - "summary": "Get landing page info", - "description": "Get information about a specific page.", - "parameters": [ - { - "name": "fields", - "x-title": "Fields", - "in": "query", - "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "exclude_fields", - "x-title": "Exclude Fields", - "in": "query", - "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "in": "path", - "name": "page_id", - "x-title": "Landing Page unique ID", - "type": "string", - "required": true, - "description": "The unique id for the page." - } - ], - "responses": { - "200": { - "description": "Landing Pages Instance", - "schema": { - "type": "object", - "title": "Landing Page", - "description": "A summary of an individual landing page's settings and content.", - "properties": { - "id": { - "type": "string", - "title": "Landing Page ID", - "description": "A string that uniquely identifies this landing page.", - "readOnly": true, - "example": "030092c2e1f0" - }, - "name": { - "type": "string", - "title": "Landing Page Name", - "description": "The name of this landing page.", - "readOnly": false }, - "title": { - "type": "string", - "title": "Landing Page title", - "description": "The title of this landing page seen in the browser's title bar.", - "readOnly": false - }, - "description": { + "long_archive_url": { "type": "string", - "title": "Landing Page description", - "description": "The description of this landing page.", - "readOnly": false - }, - "template_id": { - "type": "integer", - "title": "Landing Page template_id", - "description": "The template_id of this landing page.", + "title": "Long Archive URL", + "description": "The original link to the campaign's archive version.", "readOnly": true }, "status": { "type": "string", - "title": "Landing Page status", - "description": "The status of this landing page.", + "title": "Campaign Status", + "description": "The current status of the campaign.", "enum": [ - "published", - "unpublished", - "draft" + "save", + "paused", + "schedule", + "sending", + "sent", + "canceled", + "canceling", + "archived" ], "readOnly": true }, - "list_id": { - "type": "string", - "title": "Landing Page list id", - "description": "The list's ID associated with this landing page.", - "example": "fde02ad86b", - "readOnly": false - }, - "store_id": { - "type": "string", - "title": "Store ID", - "description": "The ID of the store associated with this landing page.", - "readOnly": false - }, - "web_id": { + "emails_sent": { "type": "integer", - "title": "Landing Page Web ID", - "description": "The ID used in the Mailchimp web application." - }, - "created_by_source": { - "type": "string", - "title": "Created By Source", - "description": "Created by mobile or web", - "readOnly": true - }, - "url": { - "type": "string", - "title": "Published url", - "description": "The url of the published landing page.", + "title": "Emails Sent", + "description": "The total number of emails sent for this campaign.", "readOnly": true }, - "created_at": { + "send_time": { "type": "string", - "title": "Created At", - "description": "The time this landing page was created.", "format": "date-time", + "title": "Send Time", + "description": "The date and time a campaign was sent in ISO 8601 format.", "readOnly": true }, - "published_at": { + "content_type": { "type": "string", - "title": "Published at", - "description": "The time this landing page was published.", - "format": "date-time", + "title": "Content Type", + "description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').", "readOnly": true }, - "unpublished_at": { - "type": "string", - "title": "Unpublished at", - "description": "The time this landing page was unpublished.", - "format": "date-time", + "needs_block_refresh": { + "type": "boolean", + "title": "Needs Block Refresh", + "description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false.", "readOnly": true }, - "updated_at": { - "type": "string", - "title": "Updated_at", - "description": "The time this landing page was updated at.", - "format": "date-time", + "resendable": { + "type": "boolean", + "title": "Resendable", + "description": "Determines if the campaign qualifies to be resent to non-openers.", "readOnly": true }, - "tracking": { + "recipients": { "type": "object", - "title": "Tracking Settings", - "description": "The tracking settings applied to this landing page.", + "title": "List", + "description": "List settings for the campaign.", + "required": [ + "list_id" + ], "properties": { - "track_with_mailchimp": { - "type": "boolean", - "title": "Track with Mailchimp", - "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." + "list_id": { + "type": "string", + "title": "List ID", + "description": "The unique list id." }, - "enable_restricted_data_processing": { - "type": "boolean", - "title": "Enable restricted data processing", - "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." - } - } - }, - "_links": { - "title": "Links", + "list_name": { + "type": "string", + "title": "List Name", + "description": "The name of the list.", + "readOnly": true + }, + "segment_text": { + "type": "string", + "title": "Segment Text", + "description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML.", + "readOnly": true + }, + "recipient_count": { + "type": "integer", + "title": "Recipient Count", + "description": "Count of the recipients on the associated list. Formatted as an integer.", + "readOnly": true + }, + "segment_opts": { + "type": "object", + "title": "Segment Options", + "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.", + "properties": { + "saved_segment_id": { + "type": "integer", + "title": "Saved Segment ID", + "description": "The id for an existing saved segment." + }, + "prebuilt_segment_id": { + "type": "string", + "title": "Prebuilt Segment Id", + "description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign.", + "example": "subscribers-female" + }, + "match": { + "type": "string", + "title": "Match Type", + "description": "Segment match type.", + "enum": [ + "any", + "all" + ] + }, + "conditions": { + "type": "array", + "title": "Segment Type", + "description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).", + "items": { + "x-discriminator": { + "type": "string", + "propertyName": "condition_type" + }, + "x-oneOf": [ + { + "type": "object", + "title": "Aim Segment", + "description": "Segment by interaction with a specific campaign.", + "properties": { + "condition_type": { + "type": "string", + "x-value": "Aim", + "enum": [ + "Aim" + ] + }, + "field": { + "type": "string", + "enum": [ + "aim" + ], + "title": "Segment Field", + "description": "Segment by interaction with a specific campaign.", + "example": "aim" + }, + "op": { + "type": "string", + "enum": [ + "open", + "click", + "sent", + "noopen", + "noclick", + "nosent" + ], + "title": "Segment Operator", + "description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent.", + "example": "open" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", + "example": "any" + } + } + }, + { + "type": "object", + "title": "Automation Segment", + "description": "Segment by interaction with an Automation workflow.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "Automation", + "enum": [ + "Automation" + ] + }, + "field": { + "type": "string", + "enum": [ + "automation" + ], + "title": "Segment Field", + "description": "Segment by interaction with an Automation workflow.", + "example": "automation" + }, + "op": { + "type": "string", + "enum": [ + "started", + "completed", + "not_started", + "not_completed" + ], + "title": "Segment Operator", + "description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.", + "example": "started" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "The web id for the automation workflow to segment against.", + "example": "2135217" + } + } + }, + { + "type": "object", + "title": "Poll Activity Segment", + "description": "Segment by poll activity.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "CampaignPoll", + "enum": [ + "CampaignPoll" + ] + }, + "field": { + "type": "string", + "enum": [ + "poll" + ], + "title": "Segment Field", + "description": "Segment by poll activity.", + "example": "poll" + }, + "op": { + "type": "string", + "enum": [ + "member", + "notmember" + ], + "title": "Segment Operator", + "description": "Members have/have not interacted with a specific poll in a Mailchimp email.", + "example": "member" + }, + "value": { + "type": "number", + "title": "Segment Operator", + "description": "The id for the poll.", + "example": 409 + } + } + }, + { + "type": "object", + "title": "Conversation Segment", + "description": "Segment by interaction with a campaign via Conversations.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "Conversation", + "enum": [ + "Conversation" + ] + }, + "field": { + "type": "string", + "enum": [ + "conversation" + ], + "title": "Segment Field", + "description": "Segment by interaction with a campaign via Conversations.", + "example": "conversation" + }, + "op": { + "type": "string", + "enum": [ + "member", + "notmember" + ], + "title": "Segment Operator", + "description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied.", + "example": "member" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", + "example": "any" + } + } + }, + { + "type": "object", + "title": "Date Segment", + "description": "Segment by a specific date field.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "Date", + "enum": [ + "Date" + ] + }, + "field": { + "type": "string", + "enum": [ + "timestamp_opt", + "info_changed", + "ecomm_date" + ], + "title": "Segment Field", + "description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.", + "example": "timestamp_opt" + }, + "op": { + "type": "string", + "enum": [ + "greater", + "less", + "is", + "not", + "blank", + "blank_not", + "within", + "notwithin" + ], + "title": "Segment Operator", + "description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.", + "example": "greater" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.", + "example": "date" + }, + "extra": { + "type": "string", + "title": "Segment Extra Value", + "description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.", + "example": "2015-01-30" + } + } + }, + { + "type": "object", + "title": "Email Client Segment", + "description": "Segment by use of a particular email client.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "EmailClient", + "enum": [ + "EmailClient" + ] + }, + "field": { + "type": "string", + "enum": [ + "email_client" + ], + "title": "Segment Field", + "description": "Segment by use of a particular email client.", + "example": "email_client" + }, + "op": { + "type": "string", + "enum": [ + "client_is", + "client_not" + ], + "title": "Segment Operator", + "description": "The operation to determine whether we select clients that match the value, or clients that do not match the value.", + "example": "client_is" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "The name of the email client.", + "example": "Gmail" + } + } + }, + { + "type": "object", + "title": "Language Segment", + "description": "Segment by language.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "Language", + "enum": [ + "Language" + ] + }, + "field": { + "type": "string", + "enum": [ + "language" + ], + "title": "Segment Field", + "description": "Segmenting based off of a subscriber's language.", + "example": "language" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not" + ], + "title": "Segment Operator", + "description": "Whether the member's language is or is not set to a specific language.", + "example": "is" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "A two-letter language identifier.", + "example": "en" + } + } + }, + { + "type": "object", + "title": "Member Rating Segment", + "description": "Segment by member rating.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "MemberRating", + "enum": [ + "MemberRating" + ] + }, + "field": { + "type": "string", + "enum": [ + "rating" + ], + "title": "Segment Field", + "description": "Segment by member rating.", + "example": "rating" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "greater", + "less" + ], + "title": "Segment Operator", + "description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number.", + "example": "greater" + }, + "value": { + "type": "number", + "title": "Segment Operator", + "description": "The star rating number to segment against.", + "example": 4 + } + } + }, + { + "type": "object", + "title": "Signup Source Segment", + "description": "Segment by signup source.", + "required": [ + "field", + "condition_type", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "enum": [ + "SignupSource" + ], + "x-value": "SignupSource", + "title": "Type" + }, + "field": { + "type": "string", + "enum": [ + "source" + ], + "title": "Segment Field", + "example": "source" + }, + "op": { + "type": "string", + "enum": [ + "source_is", + "source_not" + ], + "title": "Segment Operator", + "description": "Whether the member's signup source was/was not a particular value.", + "example": "source_is" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "The signup source.", + "example": "List Import" + } + } + }, + { + "type": "object", + "title": "Survey Monkey Segment", + "description": "Segment by interaction with a SurveyMonkey survey.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "SurveyMonkey", + "enum": [ + "SurveyMonkey" + ] + }, + "field": { + "type": "string", + "enum": [ + "survey_monkey" + ], + "title": "Segment Field", + "description": "Segment by interaction with a SurveyMonkey survey.", + "example": "survey_monkey" + }, + "op": { + "type": "string", + "enum": [ + "started", + "completed", + "not_started", + "not_completed" + ], + "title": "Segment Operator", + "description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.", + "example": "started" + }, + "value": { + "type": "string", + "title": "Survey ID", + "description": "The unique ID of the survey monkey survey.", + "example": "32179586" + } + } + }, + { + "type": "object", + "title": "VIP Segment", + "description": "Segment by VIP status.", + "required": [ + "field", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "VIP", + "enum": [ + "VIP" + ] + }, + "field": { + "type": "string", + "enum": [ + "gmonkey" + ], + "title": "Segment Field", + "description": "Segment by VIP status.", + "example": "gmonkey" + }, + "op": { + "type": "string", + "enum": [ + "member", + "notmember" + ], + "title": "Segment Operator", + "description": "Whether the member is or is not marked as VIP.", + "example": "member" + } + } + }, + { + "type": "object", + "title": "Interests Segment", + "description": "Segment by an interest group merge field.", + "properties": { + "condition_type": { + "type": "string", + "x-value": "Interests", + "enum": [ + "Interests" + ] + }, + "field": { + "type": "string", + "title": "Segment Field", + "description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'.", + "example": "interests-123" + }, + "op": { + "type": "string", + "enum": [ + "interestcontains", + "interestcontainsall", + "interestnotcontains" + ], + "title": "Segment Operator", + "description": "Whether the member is a part of one, all, or none of the groups.", + "example": "interestcontains" + }, + "value": { + "type": "array", + "title": "Segment Value", + "description": "An array containing strings, each representing a group id.", + "items": { + "type": "string", + "example": [ + "44401", + "44405", + "44409" + ] + } + } + } + }, + { + "type": "object", + "title": "Ecommerce Category Segment", + "description": "Segment by purchases in specific items or categories.", + "properties": { + "condition_type": { + "type": "string", + "x-value": "EcommCategory", + "enum": [ + "EcommCategory" + ] + }, + "field": { + "type": "string", + "enum": [ + "ecomm_cat", + "ecomm_prod" + ], + "title": "Segment Field", + "description": "Segment by purchases in specific items or categories.", + "example": "ecomm_cat" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "contains", + "notcontain", + "starts", + "ends" + ], + "title": "Segment Operator", + "description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string.", + "example": "is" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "The ecommerce category/item information.", + "example": "Product" + } + } + }, + { + "type": "object", + "title": "Ecommerce Number Segment", + "description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "EcommNumber", + "enum": [ + "EcommNumber" + ] + }, + "field": { + "type": "string", + "enum": [ + "ecomm_spent_avg", + "ecomm_orders", + "ecomm_prod_all", + "ecomm_avg_ord" + ], + "title": "Segment Field", + "description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order.", + "example": "ecomm_orders" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "greater", + "less" + ], + "title": "Segment Operator", + "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.", + "example": "greater" + }, + "value": { + "type": "number", + "title": "Segment Operator", + "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.", + "example": 42 + } + } + }, + { + "type": "object", + "title": "Ecommerce Purchased Segment", + "description": "Segment by whether someone has purchased anything.", + "properties": { + "condition_type": { + "type": "string", + "x-value": "EcommPurchased", + "enum": [ + "EcommPurchased" + ] + }, + "field": { + "type": "string", + "enum": [ + "ecomm_purchased" + ], + "title": "Segment Field", + "description": "Segment by whether someone has purchased anything.", + "example": "ecomm_purchased" + }, + "op": { + "type": "string", + "enum": [ + "member", + "notmember" + ], + "title": "Segment Operator", + "description": "Members who have have ('member') or have not ('notmember') purchased.", + "example": "member" + } + } + }, + { + "type": "object", + "title": "Ecommerce Spent Segment", + "description": "Segment by amount spent on a single order or across all orders.", + "properties": { + "condition_type": { + "type": "string", + "x-value": "EcommSpent", + "enum": [ + "EcommSpent" + ] + }, + "field": { + "type": "string", + "enum": [ + "ecomm_spent_one", + "ecomm_spent_all" + ], + "title": "Segment Field", + "description": "Segment by amount spent on a single order or across all orders.", + "example": "ecomm_spent_one" + }, + "op": { + "type": "string", + "enum": [ + "greater", + "less" + ], + "title": "Segment Operator", + "description": "Members who have spent 'more' or 'less' than then specified value.", + "example": "greater" + }, + "value": { + "type": "integer", + "title": "Segment Data", + "description": "The total amount a member spent.", + "example": 42 + } + } + }, + { + "type": "object", + "title": "Ecommerce Purchased Store Segment", + "description": "Segment by purchases from a specific store.", + "properties": { + "condition_type": { + "type": "string", + "x-value": "EcommStore", + "enum": [ + "EcommStore" + ] + }, + "field": { + "type": "string", + "enum": [ + "ecomm_store" + ], + "title": "Segment Field", + "description": "Segment by purchases from a specific store.", + "example": "ecomm_store" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not" + ], + "title": "Segment Operator", + "description": "Members who have or have not purchased from a specific store.", + "example": "is" + }, + "value": { + "type": "string", + "title": "Segment Operator", + "description": "The store id to segment against.", + "example": "289" + } + } + }, + { + "type": "object", + "title": "Goal Activity Segment", + "description": "Segment by Goal activity.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "GoalActivity", + "enum": [ + "GoalActivity" + ] + }, + "field": { + "type": "string", + "enum": [ + "goal" + ], + "title": "Segment Field", + "description": "Segment by Goal activity.", + "example": "goal" + }, + "op": { + "type": "string", + "enum": [ + "is", + "goal_not", + "contains", + "goal_notcontain", + "starts", + "ends" + ], + "title": "Segment Operator", + "description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string.", + "example": "is" + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "The URL to check Goal activity against." + } + } + }, + { + "type": "object", + "title": "Goal Timestamp Segment", + "description": "Segment by most recent interaction with a website.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "GoalTimestamp", + "enum": [ + "GoalTimestamp" + ] + }, + "field": { + "type": "string", + "enum": [ + "goal_last_visited" + ], + "title": "Segment Field", + "description": "Segment by most recent interaction with a website.", + "example": "goal_last_visited" + }, + "op": { + "type": "string", + "enum": [ + "greater", + "less", + "is" + ], + "title": "Segment Operator", + "description": "Whether the website activity happened after, before, or at a given timestamp.", + "example": "greater" + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "The date to check Goal activity against.", + "example": "2015-07-20 19:45:21" + } + } + }, + { + "type": "object", + "title": "Similar Subscribers Segment Member Segment", + "description": "Segment by similar subscribers.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "FuzzySegment", + "enum": [ + "FuzzySegment" + ] + }, + "field": { + "type": "string", + "enum": [ + "fuzzy_segment" + ], + "title": "Segment Field", + "description": "Segment by similar subscribers.", + "example": "fuzzy_segment" + }, + "op": { + "type": "string", + "enum": [ + "fuzzy_is", + "fuzzy_not" + ], + "title": "Segment Operator", + "description": "Members who are/are not apart of a 'similar subscribers' segment.", + "example": "fuzzy_is" + }, + "value": { + "type": "number", + "title": "Segment Operator", + "description": "The id for the 'similar subscribers' segment.", + "example": 48433 + } + } + }, + { + "type": "object", + "title": "Static Segment Member Segment", + "description": "Segment by a given static segment.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "StaticSegment", + "enum": [ + "StaticSegment" + ] + }, + "field": { + "type": "string", + "enum": [ + "static_segment" + ], + "title": "Segment Field", + "description": "Segment by a given static segment.", + "example": "static_segment" + }, + "op": { + "type": "string", + "enum": [ + "static_is", + "static_not" + ], + "title": "Segment Operator", + "description": "Members who are/are not apart of a static segment.", + "example": "static_is" + }, + "value": { + "type": "number", + "title": "Segment Operator", + "description": "The id for the static segment.", + "example": 48433 + } + } + }, + { + "type": "object", + "title": "Location-Based Segment", + "description": "Segment by a specific country or US state.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "IPGeoCountryState", + "enum": [ + "IPGeoCountryState" + ] + }, + "field": { + "type": "string", + "enum": [ + "ipgeo" + ], + "title": "Segment Field", + "description": "Segmenting subscribers who are within a specific location.", + "example": "ipgeo" + }, + "op": { + "type": "string", + "enum": [ + "ipgeocountry", + "ipgeonotcountry", + "ipgeostate", + "ipgeonotstate" + ], + "title": "Segment Operator", + "description": "Segment members who are within a specific country or US state.", + "example": "ipgeocountry" + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "The two-letter country code or US state abbreviation.", + "example": "US" + } + } + }, + { + "type": "object", + "title": "Geolocation Segment", + "description": "Segment by a specific geographic region.", + "required": [ + "field", + "op", + "value", + "addr", + "lat", + "lng" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "IPGeoIn", + "enum": [ + "IPGeoIn" + ] + }, + "field": { + "type": "string", + "enum": [ + "ipgeo" + ], + "title": "Segment Field", + "description": "Segmenting subscribers who are within a specific location.", + "example": "ipgeo" + }, + "op": { + "type": "string", + "enum": [ + "ipgeoin", + "ipgeonotin" + ], + "title": "Segment Operator", + "description": "Segment members who are within a specific geographic region.", + "example": "ipgeoin" + }, + "value": { + "type": "integer", + "title": "Segment Data", + "description": "The radius of the target location.", + "example": 42 + }, + "addr": { + "type": "string", + "title": "Segment Location Address", + "description": "The address of the target location.", + "example": "Atlanta, GA, USA" + }, + "lat": { + "type": "string", + "title": "Segment Location Latitude", + "description": "The latitude of the target location.", + "example": "33.7489954" + }, + "lng": { + "type": "string", + "title": "Segment Location Longitude", + "description": "The longitude of the target location.", + "example": "-84.3879824" + } + } + }, + { + "type": "object", + "title": "US Zip Code Segment", + "description": "Segment by a specific US ZIP code.", + "required": [ + "field", + "op", + "value", + "extra" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "IPGeoInZip", + "enum": [ + "IPGeoInZip" + ] + }, + "field": { + "type": "string", + "enum": [ + "ipgeo" + ], + "title": "Segment Field", + "description": "Segmenting subscribers who are within a specific location.", + "example": "ipgeo" + }, + "op": { + "type": "string", + "enum": [ + "ipgeoinzip" + ], + "title": "Segment Operator", + "description": "Segment members who are within a specific US zip code.", + "example": "ipgeoinzip" + }, + "value": { + "type": "integer", + "title": "Segment Data", + "description": "The radius of the target location.", + "example": 25 + }, + "extra": { + "type": "integer", + "title": "Extra Data", + "description": "The zip code to segment against.", + "example": 30318 + } + } + }, + { + "type": "object", + "title": "Unknown Location-Based Segment", + "description": "Segment members whose location information is unknown.", + "required": [ + "field", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "IPGeoUnknown", + "enum": [ + "IPGeoUnknown" + ] + }, + "field": { + "type": "string", + "enum": [ + "ipgeo" + ], + "title": "Segment Field", + "description": "Segmenting subscribers who are within a specific location.", + "example": "ipgeo" + }, + "op": { + "type": "string", + "enum": [ + "ipgeounknown" + ], + "title": "Segment Operator", + "description": "Segment members for which location information is unknown.", + "example": "ipgeounknown" + } + } + }, + { + "type": "object", + "title": "Zip Code Location-Based Segment", + "description": "Segment by a specific US ZIP code.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "IPGeoZip", + "enum": [ + "IPGeoZip" + ] + }, + "field": { + "type": "string", + "enum": [ + "ipgeo" + ], + "title": "Segment Field", + "description": "Segmenting subscribers who are within a specific location.", + "example": "ipgeo" + }, + "op": { + "type": "string", + "enum": [ + "ipgeoiszip", + "ipgeonotzip" + ], + "title": "Segment Operator", + "description": "Segment members who are/are not within a specific US zip code.", + "example": "ipgeonotzip" + }, + "value": { + "type": "integer", + "title": "Segment Data", + "description": "The 5-digit zip code.", + "example": 30318 + } + } + }, + { + "type": "object", + "title": "Social Profiles Age Segment", + "description": "Segment by age ranges in Social Profiles data.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "SocialAge", + "enum": [ + "SocialAge" + ] + }, + "field": { + "type": "string", + "enum": [ + "social_age" + ], + "title": "Segment Field", + "description": "Segment by age ranges in Social Profiles data.", + "example": "social_age" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not" + ], + "title": "Segment Operator", + "description": "Members who are/not the exact criteria listed.", + "example": "is" + }, + "value": { + "type": "string", + "enum": [ + "18-24", + "25-34", + "35-54", + "55+" + ], + "title": "Segment Operator", + "description": "The age range to segment.", + "example": "35-54" + } + } + }, + { + "type": "object", + "title": "Social Profiles Gender Segment", + "description": "Segment by listed gender in Social Profiles data.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "SocialGender", + "enum": [ + "SocialGender" + ] + }, + "field": { + "type": "string", + "enum": [ + "social_gender" + ], + "title": "Segment Field", + "description": "Segment by listed gender in Social Profiles data.", + "example": "social_gender" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not" + ], + "title": "Segment Operator", + "description": "Members who are/not the exact criteria listed.", + "example": "is" + }, + "value": { + "type": "string", + "enum": [ + "male", + "female" + ], + "title": "Segment Operator", + "description": "The Social Profiles gender to segment.", + "example": "female" + } + } + }, + { + "type": "object", + "title": "Social Profiles Influence Segment", + "description": "Segment by influence rating in Social Profiles data.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "SocialInfluence", + "enum": [ + "SocialInfluence" + ] + }, + "field": { + "type": "string", + "enum": [ + "social_influence" + ], + "title": "Segment Field", + "description": "Segment by influence rating in Social Profiles data.", + "example": "social_influence" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "greater", + "less" + ], + "title": "Segment Operator", + "description": "Members who have a rating that is/not or greater/less than the rating provided.", + "example": "greater" + }, + "value": { + "type": "number", + "title": "Segment Operator", + "description": "The Social Profiles influence rating to segment.", + "example": 2 + } + } + }, + { + "type": "object", + "title": "Social Profiles Social Network Segment", + "description": "Segment by social network in Social Profiles data.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "SocialNetworkMember", + "enum": [ + "SocialNetworkMember" + ] + }, + "field": { + "type": "string", + "enum": [ + "social_network" + ], + "title": "Segment Field", + "description": "Segment by social network in Social Profiles data.", + "example": "social_network" + }, + "op": { + "type": "string", + "enum": [ + "member", + "notmember" + ], + "title": "Segment Operator", + "description": "Members who are/not on a given social network.", + "example": "member" + }, + "value": { + "type": "string", + "enum": [ + "twitter", + "facebook", + "linkedin", + "flickr", + "foursquare", + "lastfm", + "myspace", + "quora", + "vimeo", + "yelp", + "youtube" + ], + "title": "Segment Operator", + "description": "The social network to segment against.", + "example": "twitter" + } + } + }, + { + "type": "object", + "title": "Social Profiles Social Network Follow Segment", + "description": "Segment by social network in Social Profiles data.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "SocialNetworkFollow", + "enum": [ + "SocialNetworkFollow" + ] + }, + "field": { + "type": "string", + "enum": [ + "social_network" + ], + "title": "Segment Field", + "description": "Segment by social network in Social Profiles data.", + "example": "social_network" + }, + "op": { + "type": "string", + "enum": [ + "follow", + "notfollow" + ], + "title": "Segment Operator", + "description": "Members who are/not following a linked account on a given social network.", + "example": "follow" + }, + "value": { + "type": "string", + "enum": [ + "twitter_follow" + ], + "title": "Segment Operator", + "description": "The social network to segment against.", + "example": "twitter_follow" + } + } + }, + { + "type": "object", + "title": "Address Merge Field Segment", + "description": "Segment by an address-type merge field.", + "required": [ + "field", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "AddressMerge", + "enum": [ + "AddressMerge" + ] + }, + "field": { + "type": "string", + "title": "Segment Field", + "description": "An address-type merge field to segment.", + "example": "MMERGE3" + }, + "op": { + "type": "string", + "enum": [ + "contains", + "notcontain", + "blank", + "blank_not" + ], + "title": "Segment Operator", + "description": "Whether the member's address merge field contains/does not contain a value or is/is not blank.", + "example": "contains" + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "The value to segment a text merge field with.", + "example": "Atlanta" + } + } + }, + { + "type": "object", + "title": "Address/Zip Merge Field Segment", + "description": "Segment by an address-type merge field within a given distance.", + "required": [ + "field", + "op", + "value", + "extra" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "ZipMerge", + "enum": [ + "ZipMerge" + ] + }, + "field": { + "type": "string", + "title": "Segment Field", + "description": "An address or zip-type merge field to segment.", + "example": "MMERGE2" + }, + "op": { + "type": "string", + "enum": [ + "geoin" + ], + "title": "Segment Operator", + "description": "Whether the member's address merge field is within a given distance from a city or zip.", + "example": "geoin" + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "The distance from the city/zip.", + "example": "25" + }, + "extra": { + "type": "string", + "title": "Segment Extra", + "description": "The city or the zip being used to segment against.", + "example": "30318" + } + } + }, + { + "type": "object", + "title": "Birthday Merge Field Segment", + "description": "Segment by a contact's birthday.", + "required": [ + "field", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "BirthdayMerge", + "enum": [ + "BirthdayMerge" + ] + }, + "field": { + "type": "string", + "title": "Segment Field", + "description": "A date merge field to segment.", + "example": "MMERGE4" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "blank", + "blank_not" + ], + "title": "Segment Operator", + "description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank.", + "example": "is" + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "A date to segment against (mm/dd).", + "example": "01/30" + } + } + }, + { + "type": "object", + "title": "Date Merge Field Segment", + "description": "Segment by a given date merge field.", + "required": [ + "field", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "DateMerge", + "enum": [ + "DateMerge" + ] + }, + "field": { + "type": "string", + "title": "Segment Field", + "description": "A date merge field to segment.", + "example": "MMERGE5" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "less", + "blank", + "blank_not", + "greater" + ], + "title": "Segment Operator", + "description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank.", + "example": "is" + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "A date to segment against.", + "example": "01/30/2015" + } + } + }, + { + "type": "object", + "title": "Dropdown/Radio Merge Field Segment", + "description": "An individual segment condition", + "required": [ + "field", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "SelectMerge", + "enum": [ + "SelectMerge" + ] + }, + "field": { + "type": "string", + "title": "Segment Field", + "description": "A merge field to segment.", + "example": "MMERGE6" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "blank", + "blank_not", + "notcontain", + "contains" + ], + "title": "Segment Operator", + "description": "Whether the member's merge information is/is not a value or is/is not blank.", + "example": "is" + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "The value to segment a text merge field with.", + "example": "Second Choice" + } + } + }, + { + "type": "object", + "title": "Text or Number Merge Field Segment", + "description": "Segment by a given text or number merge field.", + "required": [ + "field", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "TextMerge", + "enum": [ + "TextMerge" + ] + }, + "field": { + "type": "string", + "title": "Segment Field", + "description": "A text or number merge field to segment.", + "example": "MMERGE7" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "contains", + "notcontain", + "starts", + "ends", + "greater", + "less", + "blank", + "blank_not" + ], + "title": "Segment Operator", + "description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value", + "example": "contains" + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "The value to segment a text or number merge field with.", + "example": "Freddie's Jokes" + } + } + }, + { + "type": "object", + "title": "Email Segment", + "description": "Segment by email address.", + "required": [ + "field", + "op" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "EmailAddress", + "enum": [ + "EmailAddress" + ] + }, + "field": { + "type": "string", + "enum": [ + "merge0", + "EMAIL" + ], + "title": "Segment Field", + "description": "Segmenting based off of a subscriber's email address.", + "example": "EMAIL" + }, + "op": { + "type": "string", + "enum": [ + "is", + "not", + "contains", + "notcontain", + "starts", + "ends", + "greater", + "less" + ], + "title": "Segment Operator", + "description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string." + }, + "value": { + "type": "string", + "title": "Segment Value", + "description": "The value to compare the email against.", + "example": "urist.mcvankab@freddiesjokes.com" + } + } + }, + { + "type": "object", + "title": "Predicted Gender Segment", + "description": "Segment by predicted gender.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "PredictedGender", + "enum": [ + "PredictedGender" + ] + }, + "field": { + "type": "string", + "enum": [ + "predicted_gender" + ], + "title": "Segment Field", + "description": "Segment by predicted gender." + }, + "op": { + "type": "string", + "enum": [ + "is", + "not" + ], + "title": "Segment Operator", + "description": "Members who are/not the exact criteria listed.", + "example": "is" + }, + "value": { + "type": "string", + "enum": [ + "male", + "female" + ], + "title": "Segment Operator", + "description": "The predicted gender to segment.", + "example": "female" + } + } + }, + { + "type": "object", + "title": "Predicted Age Segment", + "description": "Segment by predicted age.", + "required": [ + "field", + "op", + "value" + ], + "properties": { + "condition_type": { + "type": "string", + "x-value": "PredictedAge", + "enum": [ + "PredictedAge" + ] + }, + "field": { + "type": "string", + "enum": [ + "predicted_age_range" + ], + "title": "Segment Field", + "description": "Segment by predicted age." + }, + "op": { + "type": "string", + "enum": [ + "is" + ], + "title": "Segment Operator", + "description": "Members who are/not the exact criteria listed.", + "example": "is" + }, + "value": { + "type": "string", + "enum": [ + "18-24", + "25-34", + "35-44", + "45-54", + "55-64", + "65+" + ], + "title": "Segment Operator", + "description": "The predicted age to segment.", + "example": "female" + } + } + }, + { + "type": "object", + "title": "New Subscribers Prebuilt Segment", + "description": "Segment by when people subscribed.", + "properties": { + "condition_type": { + "type": "string", + "x-value": "NewSubscribers", + "enum": [ + "NewSubscribers" + ] + }, + "field": { + "type": "string", + "enum": [ + "timestamp_opt" + ], + "title": "Segment Field", + "description": "Segment by when people subscribed." + }, + "op": { + "type": "string", + "enum": [ + "date_within" + ], + "title": "Segment Operator", + "description": "Whe the event took place, namely within a time frame." + }, + "value": { + "type": "string", + "title": "Segment Data", + "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." + } + } + } + ] + } + } + } + } + } + }, + "settings": { + "type": "object", + "title": "Campaign Settings", + "description": "The settings for your campaign, including subject, from name, reply-to address, and more.", + "properties": { + "subject_line": { + "type": "string", + "title": "Campaign Subject Line", + "description": "The subject line for the campaign." + }, + "preview_text": { + "type": "string", + "title": "Campaign Preview Text", + "description": "The preview text for the campaign." + }, + "title": { + "type": "string", + "title": "Campaign Title", + "description": "The title of the campaign." + }, + "from_name": { + "type": "string", + "title": "From Name", + "description": "The 'from' name on the campaign (not an email address)." + }, + "reply_to": { + "type": "string", + "title": "Reply To Address", + "description": "The reply-to email address for the campaign." + }, + "use_conversation": { + "type": "boolean", + "title": "Conversation", + "description": "Use Mailchimp Conversation feature to manage replies." + }, + "to_name": { + "type": "string", + "title": "To Name", + "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", + "title": "Folder ID", + "description": "If the campaign is listed in a folder, the id for that folder." + }, + "authenticate": { + "type": "boolean", + "title": "Authentication", + "description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`." + }, + "auto_footer": { + "type": "boolean", + "title": "Auto-Footer", + "description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign." + }, + "inline_css": { + "type": "boolean", + "title": "Inline CSS", + "description": "Automatically inline the CSS included with the campaign content." + }, + "auto_tweet": { + "type": "boolean", + "title": "Auto-Tweet", + "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", + "title": "Auto Post to Facebook", + "description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to.", + "items": { + "type": "string" + } + }, + "fb_comments": { + "type": "boolean", + "title": "Facebook Comments", + "description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`." + }, + "timewarp": { + "type": "boolean", + "title": "Timewarp Send", + "description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/).", + "readOnly": true + }, + "template_id": { + "type": "integer", + "title": "Template ID", + "description": "The id for the template used in this campaign.", + "readOnly": true + }, + "drag_and_drop": { + "type": "boolean", + "title": "Drag And Drop Campaign", + "description": "Whether the campaign uses the drag-and-drop editor.", + "readOnly": true + } + } + }, + "variate_settings": { + "type": "object", + "title": "A/B Test Options", + "description": "The settings specific to A/B test campaigns.", + "required": [ + "winner_criteria" + ], + "properties": { + "winning_combination_id": { + "type": "string", + "title": "Winning Combination ID", + "description": "ID for the winning combination.", + "readOnly": true + }, + "winning_campaign_id": { + "type": "string", + "title": "Winning Campaign ID", + "description": "ID of the campaign that was sent to the remaining recipients based on the winning combination.", + "readOnly": true + }, + "winner_criteria": { + "type": "string", + "title": "Winning Criteria", + "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", + "title": "Wait Time", + "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", + "title": "Test Size", + "description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100." + }, + "subject_lines": { + "type": "array", + "title": "Subject Lines", + "description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.", + "items": { + "type": "string" + } + }, + "send_times": { + "type": "array", + "title": "Send Times", + "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.", + "items": { + "type": "string", + "format": "date-time" + } + }, + "from_names": { + "type": "array", + "title": "From Names", + "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.", + "items": { + "type": "string" + } + }, + "reply_to_addresses": { + "type": "array", + "title": "Reply To Addresses", + "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.", + "items": { + "type": "string" + } + }, + "contents": { + "type": "array", + "title": "Content Descriptions", + "description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "combinations": { + "type": "array", + "title": "Combinations", + "description": "Combinations of possible variables used to build emails.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "Unique ID for the combination." + }, + "subject_line": { + "type": "integer", + "title": "Subject Line", + "description": "The index of `variate_settings.subject_lines` used." + }, + "send_time": { + "type": "integer", + "title": "Send Time", + "description": "The index of `variate_settings.send_times` used." + }, + "from_name": { + "type": "integer", + "title": "From Name", + "description": "The index of `variate_settings.from_names` used." + }, + "reply_to": { + "type": "integer", + "title": "Reply To", + "description": "The index of `variate_settings.reply_to_addresses` used." + }, + "content_description": { + "type": "integer", + "title": "Content Description", + "description": "The index of `variate_settings.contents` used." + }, + "recipients": { + "type": "integer", + "title": "Recipients", + "description": "The number of recipients for this combination." + } + } + } + } + } + }, + "tracking": { + "type": "object", + "title": "Campaign Tracking Options", + "description": "The tracking options for a campaign.", + "properties": { + "opens": { + "type": "boolean", + "title": "Opens", + "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", + "title": "HTML Click Tracking", + "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", + "title": "Plain-Text Click Tracking", + "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", + "title": "Mailchimp Goal Tracking", + "description": "Deprecated" + }, + "ecomm360": { + "type": "boolean", + "title": "E-commerce Tracking", + "description": "Whether to enable e-commerce tracking." + }, + "google_analytics": { + "type": "string", + "title": "Google Analytics Tracking", + "description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)." + }, + "clicktale": { + "type": "string", + "title": "ClickTale Analytics Tracking", + "description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)." + }, + "salesforce": { + "type": "object", + "title": "Salesforce CRM Tracking", + "description": "Deprecated", + "properties": { + "campaign": { + "type": "boolean", + "title": "Salesforce Campaign", + "description": "Create a campaign in a connected Salesforce account." + }, + "notes": { + "type": "boolean", + "title": "Salesforce Note", + "description": "Update contact notes for a campaign based on subscriber email addresses." + } + } + }, + "capsule": { + "type": "object", + "title": "Capsule CRM Tracking", + "description": "Deprecated", + "properties": { + "notes": { + "type": "boolean", + "title": "Capsule Note", + "description": "Update contact notes for a campaign based on subscriber email addresses." + } + } + } + } + }, + "rss_opts": { + "type": "object", + "title": "RSS Options", + "description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign.", + "required": [ + "feed_url", + "frequency" + ], + "properties": { + "feed_url": { + "type": "string", + "title": "Feed URL", + "format": "uri", + "description": "The URL for the RSS feed." + }, + "frequency": { + "type": "string", + "title": "Frequency", + "description": "The frequency of the RSS Campaign.", + "enum": [ + "daily", + "weekly", + "monthly" + ] + }, + "schedule": { + "type": "object", + "title": "Sending Schedule", + "description": "The schedule for sending the RSS Campaign.", + "properties": { + "hour": { + "type": "integer", + "minimum": 0, + "maximum": 23, + "title": "Sending Hour", + "description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)." + }, + "daily_send": { + "type": "object", + "title": "Daily Sending Days", + "description": "The days of the week to send a daily RSS Campaign.", + "properties": { + "sunday": { + "type": "boolean", + "title": "Sunday", + "description": "Sends the daily RSS Campaign on Sundays." + }, + "monday": { + "type": "boolean", + "title": "Monday", + "description": "Sends the daily RSS Campaign on Mondays." + }, + "tuesday": { + "type": "boolean", + "title": "tuesday", + "description": "Sends the daily RSS Campaign on Tuesdays." + }, + "wednesday": { + "type": "boolean", + "title": "Monday", + "description": "Sends the daily RSS Campaign on Wednesdays." + }, + "thursday": { + "type": "boolean", + "title": "Thursday", + "description": "Sends the daily RSS Campaign on Thursdays." + }, + "friday": { + "type": "boolean", + "title": "Friday", + "description": "Sends the daily RSS Campaign on Fridays." + }, + "saturday": { + "type": "boolean", + "title": "Saturday", + "description": "Sends the daily RSS Campaign on Saturdays." + } + } + }, + "weekly_send_day": { + "type": "string", + "enum": [ + "sunday", + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday" + ], + "title": "Weekly Sending Day", + "description": "The day of the week to send a weekly RSS Campaign." + }, + "monthly_send_date": { + "type": "number", + "minimum": 0, + "maximum": 31, + "title": "Monthly Sending Day", + "description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February." + } + } + }, + "last_sent": { + "type": "string", + "format": "date-time", + "title": "Last Sent", + "description": "The date the campaign was last sent.", + "readOnly": true + }, + "constrain_rss_img": { + "type": "boolean", + "title": "Constrain RSS Images", + "description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns." + } + } + }, + "ab_split_opts": { + "type": "object", + "title": "A/B Testing Options", + "description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign.", + "readOnly": true, + "properties": { + "split_test": { + "type": "string", + "title": "Split Test", + "description": "The type of AB split to run.", + "enum": [ + "subject", + "from_name", + "schedule" + ] + }, + "pick_winner": { + "type": "string", + "title": "Pick Winner", + "description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'.", + "enum": [ + "opens", + "clicks", + "manual" + ] + }, + "wait_units": { + "type": "string", + "title": "Wait Time", + "description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent.", + "enum": [ + "hours", + "days" + ] + }, + "wait_time": { + "type": "integer", + "title": "Wait Time", + "description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent." + }, + "split_size": { + "type": "integer", + "minimum": 1, + "maximum": 50, + "title": "Split Size", + "description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50." + }, + "from_name_a": { + "type": "string", + "title": "From Name Group A", + "description": "For campaigns split on 'From Name', the name for Group A." + }, + "from_name_b": { + "type": "string", + "title": "From Name Group B", + "description": "For campaigns split on 'From Name', the name for Group B." + }, + "reply_email_a": { + "type": "string", + "title": "Reply Email Group A", + "description": "For campaigns split on 'From Name', the reply-to address for Group A." + }, + "reply_email_b": { + "type": "string", + "title": "Reply Email Group B", + "description": "For campaigns split on 'From Name', the reply-to address for Group B." + }, + "subject_a": { + "type": "string", + "title": "Subject Line Group A", + "description": "For campaigns split on 'Subject Line', the subject line for Group A." + }, + "subject_b": { + "type": "string", + "title": "Subject Line Group B", + "description": "For campaigns split on 'Subject Line', the subject line for Group B." + }, + "send_time_a": { + "type": "string", + "format": "date-time", + "title": "Send Time Group A", + "description": "The send time for Group A." + }, + "send_time_b": { + "type": "string", + "format": "date-time", + "title": "Send Time Group B", + "description": "The send time for Group B." + }, + "send_time_winner": { + "type": "string", + "title": "Send Time Winner", + "description": "The send time for the winning version." + } + } + }, + "social_card": { + "type": "object", + "title": "Campaign Social Card", + "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", + "title": "Image URL", + "description": "The url for the header image for the card." + }, + "description": { + "type": "string", + "title": "Campaign Description", + "description": "A short summary of the campaign to display." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title for the card. Typically the subject line of the campaign." + } + } + }, + "report_summary": { + "type": "object", + "title": "Campaign Report Summary", + "description": "For sent campaigns, a summary of opens and clicks.", + "properties": { + "opens": { + "type": "integer", + "title": "Automation Opens", + "description": "The total number of opens for a campaign.", + "readOnly": true + }, + "unique_opens": { + "type": "integer", + "title": "Unique Opens", + "description": "The number of unique opens.", + "readOnly": true + }, + "open_rate": { + "type": "number", + "title": "Open Rate", + "description": "The number of unique opens divided by the total number of successful deliveries.", + "readOnly": true + }, + "clicks": { + "type": "integer", + "title": "Total Clicks", + "description": "The total number of clicks for an campaign.", + "readOnly": true + }, + "subscriber_clicks": { + "type": "integer", + "title": "Unique Subscriber Clicks", + "description": "The number of unique clicks.", + "readOnly": true + }, + "click_rate": { + "type": "number", + "title": "Click Rate", + "description": "The number of unique clicks divided by the total number of successful deliveries.", + "readOnly": true + }, + "ecommerce": { + "type": "object", + "title": "E-Commerce Report", + "description": "E-Commerce stats for a campaign.", + "properties": { + "total_orders": { + "type": "integer", + "title": "Total Orders", + "description": "The total orders for a campaign.", + "readOnly": true + }, + "total_spent": { + "type": "number", + "title": "Total Spent", + "description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions.", + "readOnly": true + }, + "total_revenue": { + "type": "number", + "title": "Total Revenue", + "description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.", + "readOnly": true + } + } + } + } + }, + "delivery_status": { + "type": "object", + "title": "Campaign Delivery Status", + "description": "Updates on campaigns in the process of sending.", + "properties": { + "enabled": { + "type": "boolean", + "title": "Delivery Status Enabled", + "description": "Whether Campaign Delivery Status is enabled for this account and campaign.", + "readOnly": true + }, + "can_cancel": { + "type": "boolean", + "title": "Campaign Cancelable", + "description": "Whether a campaign send can be canceled.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Campaign Delivery Status", + "description": "The current state of a campaign delivery.", + "enum": [ + "delivering", + "delivered", + "canceling", + "canceled" + ], + "readOnly": true + }, + "emails_sent": { + "type": "integer", + "title": "Emails Sent", + "description": "The total number of emails confirmed sent for this campaign so far.", + "readOnly": true + }, + "emails_canceled": { + "type": "integer", + "title": "Emails Canceled", + "description": "The total number of emails canceled for this campaign.", + "readOnly": true + } + } + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "Surveys" + ], + "x-custom-config": { + "methodNameSnake": "create_email", + "methodNameCamel": "createEmail" + }, + "operationId": "postListsIdSurveysIdActionsCreateEmail" + } + }, + "/landing-pages": { + "get": { + "description": "Get all landing pages.", + "operationId": "getAllLandingPages", + "parameters": [ + { + "name": "sort_dir", + "x-title": "Sort Direction", + "description": "Determines the order direction for sorted results.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + { + "name": "sort_field", + "x-title": "Sort By Field", + "description": "Returns files sorted by the specified field.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "created_at", + "updated_at" + ] + }, + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "count", + "x-title": "Count", + "in": "query", + "description": "The number of records to return. Default value is 10. Maximum value is 1000", + "required": false, + "default": 10, + "maximum": 1000, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Landing Pages Collection", + "schema": { + "type": "object", + "description": "A collection of landing pages.", + "properties": { + "landing_pages": { + "type": "array", + "description": "The landing pages on the account", + "items": { + "type": "object", + "title": "Landing Page", + "description": "A summary of an individual landing page's settings and content.", + "properties": { + "id": { + "type": "string", + "title": "Landing Page ID", + "description": "A string that uniquely identifies this landing page.", + "readOnly": true, + "example": "030092c2e1f0" + }, + "name": { + "type": "string", + "title": "Landing Page Name", + "description": "The name of this landing page.", + "readOnly": false + }, + "title": { + "type": "string", + "title": "Landing Page title", + "description": "The title of this landing page seen in the browser's title bar.", + "readOnly": false + }, + "description": { + "type": "string", + "title": "Landing Page description", + "description": "The description of this landing page.", + "readOnly": false + }, + "template_id": { + "type": "integer", + "title": "Landing Page template_id", + "description": "The template_id of this landing page.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Landing Page status", + "description": "The status of this landing page.", + "enum": [ + "published", + "unpublished", + "draft" + ], + "readOnly": true + }, + "list_id": { + "type": "string", + "title": "Landing Page list id", + "description": "The list's ID associated with this landing page.", + "example": "fde02ad86b", + "readOnly": false + }, + "store_id": { + "type": "string", + "title": "Store ID", + "description": "The ID of the store associated with this landing page.", + "readOnly": false + }, + "web_id": { + "type": "integer", + "title": "Landing Page Web ID", + "description": "The ID used in the Mailchimp web application." + }, + "created_by_source": { + "type": "string", + "title": "Created By Source", + "description": "Created by mobile or web", + "readOnly": true + }, + "url": { + "type": "string", + "title": "Published url", + "description": "The url of the published landing page.", + "readOnly": true + }, + "created_at": { + "type": "string", + "title": "Created At", + "description": "The time this landing page was created.", + "format": "date-time", + "readOnly": true + }, + "published_at": { + "type": "string", + "title": "Published at", + "description": "The time this landing page was published.", + "format": "date-time", + "readOnly": true + }, + "unpublished_at": { + "type": "string", + "title": "Unpublished at", + "description": "The time this landing page was unpublished.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "title": "Updated_at", + "description": "The time this landing page was updated at.", + "format": "date-time", + "readOnly": true + }, + "tracking": { + "type": "object", + "title": "Tracking Settings", + "description": "The tracking settings applied to this landing page.", + "properties": { + "track_with_mailchimp": { + "type": "boolean", + "title": "Track with Mailchimp", + "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." + }, + "enable_restricted_data_processing": { + "type": "boolean", + "title": "Enable restricted data processing", + "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." + } + } + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "total_items": { + "type": "integer", + "title": "Item Count", + "description": "The total number of items matching the query regardless of pagination.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "tags": [ + "landingPages" + ], + "x-custom-config": { + "methodNameSnake": "get_all", + "methodNameCamel": "getAll" + }, + "summary": "List landing pages" + }, + "post": { + "summary": "Add landing page", + "description": "Create a new Mailchimp landing page.", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "", + "required": true, + "schema": { + "type": "object", + "title": "Landing Page", + "description": "A summary of an individual page's properties.", + "properties": { + "name": { + "type": "string", + "title": "Landing Page Name", + "description": "The name of this landing page." + }, + "title": { + "type": "string", + "title": "Landing Page title", + "description": "The title of this landing page seen in the browser's title bar." + }, + "description": { + "type": "string", + "title": "Landing Page description", + "description": "The description of this landing page." + }, + "store_id": { + "type": "string", + "title": "Store ID", + "description": "The ID of the store associated with this landing page." + }, + "list_id": { + "type": "string", + "title": "Landing Page list id", + "description": "The list's ID associated with this landing page." + }, + "type": { + "type": "string", + "title": "Landing Page Template Type", + "description": "The type of template the landing page has.", + "enum": [ + "signup", + "product" + ], + "example": "signup" + }, + "template_id": { + "type": "integer", + "title": "Landing Page template_id", + "description": "The template_id of this landing page.", + "example": 1001 + }, + "tracking": { + "type": "object", + "title": "Tracking Settings", + "description": "The tracking settings applied to this landing page.", + "properties": { + "track_with_mailchimp": { + "type": "boolean", + "title": "Track with Mailchimp", + "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." + }, + "enable_restricted_data_processing": { + "type": "boolean", + "title": "Enable restricted data processing", + "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." + } + } + } + } + } + }, + { + "in": "query", + "name": "use_default_list", + "x-title": "Use Default List", + "type": "boolean", + "required": false, + "description": "Will create the Landing Page using the account's Default List instead of requiring a list_id." + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "Landing Page", + "description": "A summary of an individual landing page's settings and content.", + "properties": { + "id": { + "type": "string", + "title": "Landing Page ID", + "description": "A string that uniquely identifies this landing page.", + "readOnly": true, + "example": "030092c2e1f0" + }, + "name": { + "type": "string", + "title": "Landing Page Name", + "description": "The name of this landing page.", + "readOnly": false + }, + "title": { + "type": "string", + "title": "Landing Page title", + "description": "The title of this landing page seen in the browser's title bar.", + "readOnly": false + }, + "description": { + "type": "string", + "title": "Landing Page description", + "description": "The description of this landing page.", + "readOnly": false + }, + "template_id": { + "type": "integer", + "title": "Landing Page template_id", + "description": "The template_id of this landing page.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Landing Page status", + "description": "The status of this landing page.", + "enum": [ + "published", + "unpublished", + "draft" + ], + "readOnly": true + }, + "list_id": { + "type": "string", + "title": "Landing Page list id", + "description": "The list's ID associated with this landing page.", + "example": "fde02ad86b", + "readOnly": false + }, + "store_id": { + "type": "string", + "title": "Store ID", + "description": "The ID of the store associated with this landing page.", + "readOnly": false + }, + "web_id": { + "type": "integer", + "title": "Landing Page Web ID", + "description": "The ID used in the Mailchimp web application." + }, + "created_by_source": { + "type": "string", + "title": "Created By Source", + "description": "Created by mobile or web", + "readOnly": true + }, + "url": { + "type": "string", + "title": "Published url", + "description": "The url of the published landing page.", + "readOnly": true + }, + "created_at": { + "type": "string", + "title": "Created At", + "description": "The time this landing page was created.", + "format": "date-time", + "readOnly": true + }, + "published_at": { + "type": "string", + "title": "Published at", + "description": "The time this landing page was published.", + "format": "date-time", + "readOnly": true + }, + "unpublished_at": { + "type": "string", + "title": "Unpublished at", + "description": "The time this landing page was unpublished.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "title": "Updated_at", + "description": "The time this landing page was updated at.", + "format": "date-time", + "readOnly": true + }, + "tracking": { + "type": "object", + "title": "Tracking Settings", + "description": "The tracking settings applied to this landing page.", + "properties": { + "track_with_mailchimp": { + "type": "boolean", + "title": "Track with Mailchimp", + "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." + }, + "enable_restricted_data_processing": { + "type": "boolean", + "title": "Enable restricted data processing", + "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." + } + } + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "landingPages" + ], + "x-custom-config": { + "methodNameSnake": "create", + "methodNameCamel": "create" + }, + "operationId": "postAllLandingPages" + } + }, + "/landing-pages/{page_id}": { + "get": { + "summary": "Get landing page info", + "description": "Get information about a specific page.", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "in": "path", + "name": "page_id", + "x-title": "Landing Page unique ID", + "type": "string", + "required": true, + "description": "The unique id for the page." + } + ], + "responses": { + "200": { + "description": "Landing Pages Instance", + "schema": { + "type": "object", + "title": "Landing Page", + "description": "A summary of an individual landing page's settings and content.", + "properties": { + "id": { + "type": "string", + "title": "Landing Page ID", + "description": "A string that uniquely identifies this landing page.", + "readOnly": true, + "example": "030092c2e1f0" + }, + "name": { + "type": "string", + "title": "Landing Page Name", + "description": "The name of this landing page.", + "readOnly": false + }, + "title": { + "type": "string", + "title": "Landing Page title", + "description": "The title of this landing page seen in the browser's title bar.", + "readOnly": false + }, + "description": { + "type": "string", + "title": "Landing Page description", + "description": "The description of this landing page.", + "readOnly": false + }, + "template_id": { + "type": "integer", + "title": "Landing Page template_id", + "description": "The template_id of this landing page.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Landing Page status", + "description": "The status of this landing page.", + "enum": [ + "published", + "unpublished", + "draft" + ], + "readOnly": true + }, + "list_id": { + "type": "string", + "title": "Landing Page list id", + "description": "The list's ID associated with this landing page.", + "example": "fde02ad86b", + "readOnly": false + }, + "store_id": { + "type": "string", + "title": "Store ID", + "description": "The ID of the store associated with this landing page.", + "readOnly": false + }, + "web_id": { + "type": "integer", + "title": "Landing Page Web ID", + "description": "The ID used in the Mailchimp web application." + }, + "created_by_source": { + "type": "string", + "title": "Created By Source", + "description": "Created by mobile or web", + "readOnly": true + }, + "url": { + "type": "string", + "title": "Published url", + "description": "The url of the published landing page.", + "readOnly": true + }, + "created_at": { + "type": "string", + "title": "Created At", + "description": "The time this landing page was created.", + "format": "date-time", + "readOnly": true + }, + "published_at": { + "type": "string", + "title": "Published at", + "description": "The time this landing page was published.", + "format": "date-time", + "readOnly": true + }, + "unpublished_at": { + "type": "string", + "title": "Unpublished at", + "description": "The time this landing page was unpublished.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "title": "Updated_at", + "description": "The time this landing page was updated at.", + "format": "date-time", + "readOnly": true + }, + "tracking": { + "type": "object", + "title": "Tracking Settings", + "description": "The tracking settings applied to this landing page.", + "properties": { + "track_with_mailchimp": { + "type": "boolean", + "title": "Track with Mailchimp", + "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." + }, + "enable_restricted_data_processing": { + "type": "boolean", + "title": "Enable restricted data processing", + "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." + } + } + }, + "_links": { + "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { @@ -84965,15 +89269,30 @@ "title": "Total Opens", "description": "The total number of opens for a campaign." }, + "proxy_excluded_opens": { + "type": "integer", + "title": "Proxy Excluded Opens", + "description": "The total number of opens for a campaign, excluding opens from email clients that use proxies." + }, "unique_opens": { "type": "integer", "title": "Unique Opens", - "description": "The total number of unique opens." + "description": "The total number of unique opens for a campaign." + }, + "proxy_excluded_unique_opens": { + "type": "integer", + "title": "Proxy Excluded Unique Opens", + "description": "The total number of unique opens for a campaign, excluding opens from email clients that use proxies." }, "open_rate": { "type": "number", "title": "Open Rate", - "description": "The number of unique opens divided by the total number of successful deliveries." + "description": "The number of unique opens for a campaign divided by the total number of successful deliveries." + }, + "proxy_excluded_open_rate": { + "type": "number", + "title": "Proxy Excluded Open Rate", + "description": "The average unique open rate for a campaign, excluding opens from email clients that use proxies." }, "last_open": { "type": "string", @@ -85100,7 +89419,13 @@ "open_rate": { "type": "number", "title": "Open Rate", - "description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list.", + "description": "The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list.", + "readOnly": true + }, + "proxy_excluded_open_rate": { + "type": "number", + "title": "Proxy Excluded Open Rate", + "description": "The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list, excluding opens from email clients that use proxies.", "readOnly": true }, "click_rate": { @@ -85297,6 +89622,11 @@ "title": "Unique Opens", "description": "The number of unique opens in the timeseries." }, + "proxy_excluded_unique_opens": { + "type": "integer", + "title": "Proxy Excluded Unique Opens", + "description": "The number of unique opens in the timeseries, excluding opens from email clients that use proxies." + }, "recipients_clicks": { "type": "integer", "title": "Recipient Clicks", @@ -85745,15 +90075,30 @@ "title": "Total Opens", "description": "The total number of opens for a campaign." }, + "proxy_excluded_opens": { + "type": "integer", + "title": "Proxy Excluded Opens", + "description": "The total number of opens for a campaign, excluding opens from email clients that use proxies." + }, "unique_opens": { "type": "integer", "title": "Unique Opens", - "description": "The total number of unique opens." + "description": "The total number of unique opens for a campaign." + }, + "proxy_excluded_unique_opens": { + "type": "integer", + "title": "Proxy Excluded Unique Opens", + "description": "The total number of unique opens for a campaign, excluding opens from email clients that use proxies." }, "open_rate": { "type": "number", "title": "Open Rate", - "description": "The number of unique opens divided by the total number of successful deliveries." + "description": "The number of unique opens for a campaign divided by the total number of successful deliveries." + }, + "proxy_excluded_open_rate": { + "type": "number", + "title": "Proxy Excluded Open Rate", + "description": "The average unique open rate for a campaign, excluding opens from email clients that use proxies." }, "last_open": { "type": "string", @@ -85880,7 +90225,13 @@ "open_rate": { "type": "number", "title": "Open Rate", - "description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list.", + "description": "The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list.", + "readOnly": true + }, + "proxy_excluded_open_rate": { + "type": "number", + "title": "Proxy Excluded Open Rate", + "description": "The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list, excluding opens from email clients that use proxies.", "readOnly": true }, "click_rate": { @@ -86077,6 +90428,11 @@ "title": "Unique Opens", "description": "The number of unique opens in the timeseries." }, + "proxy_excluded_unique_opens": { + "type": "integer", + "title": "Proxy Excluded Unique Opens", + "description": "The number of unique opens in the timeseries, excluding opens from email clients that use proxies." + }, "recipients_clicks": { "type": "integer", "title": "Recipient Clicks", @@ -87117,6 +91473,30 @@ "type": "string", "required": true, "description": "The unique id for the campaign." + }, + { + "name": "sort_field", + "x-title": "Sort By Field", + "description": "Returns click reports sorted by the specified field.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "total_clicks", + "unique_clicks" + ] + }, + { + "name": "sort_dir", + "x-title": "Sort Direction", + "description": "Determines the order direction for sorted results.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ] } ], "responses": { @@ -87778,576 +92158,599 @@ "description": "The unique id for the campaign." }, { - "name": "link_id", - "x-title": "Link ID", - "description": "The id for the link.", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "type": "object", - "title": "Click Detail Members", - "description": "A collection of members who clicked on a specific link within a campaign.", - "properties": { - "members": { - "type": "array", - "items": { - "type": "object", - "title": "Click Detail Member", - "description": "A subscriber who clicked a specific URL in a specific campaign.", - "properties": { - "email_id": { - "type": "string", - "title": "Email Hash", - "description": "The MD5 hash of the lowercase version of the list member's email address.", - "readOnly": true - }, - "email_address": { - "type": "string", - "title": "Email Address", - "description": "Email address for a subscriber.", - "readOnly": true - }, - "merge_fields": { - "type": "object", - "title": "Merge Fields", - "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", - "additionalProperties": { - "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." - } - }, - "vip": { - "type": "boolean", - "title": "VIP", - "description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.", - "readOnly": true - }, - "clicks": { - "type": "integer", - "title": "Total Clicks", - "description": "The total number of times the subscriber clicked on the link.", - "readOnly": true - }, - "campaign_id": { - "type": "string", - "title": "Campaign ID", - "description": "The campaign id.", - "readOnly": true - }, - "url_id": { - "type": "string", - "title": "URL ID", - "description": "The id for the tracked URL in the campaign.", - "readOnly": true - }, - "list_id": { - "type": "string", - "title": "List ID", - "description": "The list id.", - "readOnly": true - }, - "list_is_active": { - "type": "boolean", - "title": "List Status", - "description": "The status of the list used, namely if it's deleted or disabled.", - "readOnly": true - }, - "contact_status": { - "type": "string", - "title": "Member Status", - "description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.", - "readOnly": true - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - }, - "title": "Lists", - "description": "An array of objects, each representing a member who clicked a specific link within a campaign." - }, - "campaign_id": { - "type": "string", - "title": "Campaign ID", - "description": "The campaign id.", - "readOnly": true - }, - "total_items": { - "type": "integer", - "title": "Item Count", - "description": "The total number of items matching the query regardless of pagination.", - "readOnly": true - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "default": { - "description": "An error generated by the Mailchimp API.", - "schema": { - "type": "object", - "title": "Problem Detail Document", - "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", - "required": [ - "type", - "title", - "status", - "detail", - "instance" - ], - "properties": { - "type": { - "type": "string", - "title": "Problem Type", - "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", - "example": "https://mailchimp.com/developer/marketing/docs/errors/" - }, - "title": { - "type": "string", - "title": "Error Title", - "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", - "example": "Resource Not Found" - }, - "status": { - "type": "integer", - "title": "HTTP Status Code", - "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", - "example": 404 - }, - "detail": { - "type": "string", - "title": "Error Message", - "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", - "example": "The requested resource could not be found." - }, - "instance": { - "type": "string", - "title": "Instance ID", - "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", - "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" - } - } - } - } - }, - "deprecated": false, - "tags": [ - "reports" - ], - "x-custom-config": { - "methodNameSnake": "get_subscribers_info", - "methodNameCamel": "getSubscribersInfo" - } - } - }, - "/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}": { - "get": { - "summary": "Get clicked link subscriber", - "description": "Get information about a specific subscriber who clicked a link in a specific campaign.", - "operationId": "getReportsIdClickDetailsIdMembersId", - "parameters": [ - { - "name": "fields", - "x-title": "Fields", - "in": "query", - "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "exclude_fields", - "x-title": "Exclude Fields", + "name": "link_id", + "x-title": "Link ID", + "description": "The id for the link.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "Click Detail Members", + "description": "A collection of members who clicked on a specific link within a campaign.", + "properties": { + "members": { + "type": "array", + "items": { + "type": "object", + "title": "Click Detail Member", + "description": "A subscriber who clicked a specific URL in a specific campaign.", + "properties": { + "email_id": { + "type": "string", + "title": "Email Hash", + "description": "The MD5 hash of the lowercase version of the list member's email address.", + "readOnly": true + }, + "email_address": { + "type": "string", + "title": "Email Address", + "description": "Email address for a subscriber.", + "readOnly": true + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "vip": { + "type": "boolean", + "title": "VIP", + "description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.", + "readOnly": true + }, + "clicks": { + "type": "integer", + "title": "Total Clicks", + "description": "The total number of times the subscriber clicked on the link.", + "readOnly": true + }, + "campaign_id": { + "type": "string", + "title": "Campaign ID", + "description": "The campaign id.", + "readOnly": true + }, + "url_id": { + "type": "string", + "title": "URL ID", + "description": "The id for the tracked URL in the campaign.", + "readOnly": true + }, + "list_id": { + "type": "string", + "title": "List ID", + "description": "The list id.", + "readOnly": true + }, + "list_is_active": { + "type": "boolean", + "title": "List Status", + "description": "The status of the list used, namely if it's deleted or disabled.", + "readOnly": true + }, + "contact_status": { + "type": "string", + "title": "Member Status", + "description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + }, + "title": "Lists", + "description": "An array of objects, each representing a member who clicked a specific link within a campaign." + }, + "campaign_id": { + "type": "string", + "title": "Campaign ID", + "description": "The campaign id.", + "readOnly": true + }, + "total_items": { + "type": "integer", + "title": "Item Count", + "description": "The total number of items matching the query regardless of pagination.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "reports" + ], + "x-custom-config": { + "methodNameSnake": "get_subscribers_info", + "methodNameCamel": "getSubscribersInfo" + } + } + }, + "/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}": { + "get": { + "summary": "Get clicked link subscriber", + "description": "Get information about a specific subscriber who clicked a link in a specific campaign.", + "operationId": "getReportsIdClickDetailsIdMembersId", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "in": "path", + "name": "campaign_id", + "x-title": "Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the campaign." + }, + { + "name": "link_id", + "x-title": "Link ID", + "description": "The id for the link.", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscriber_hash", + "x-title": "Subscriber Hash", + "type": "string", + "required": true, + "description": "The MD5 hash of the lowercase version of the list member's email address." + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "Click Detail Member", + "description": "A subscriber who clicked a specific URL in a specific campaign.", + "properties": { + "email_id": { + "type": "string", + "title": "Email Hash", + "description": "The MD5 hash of the lowercase version of the list member's email address.", + "readOnly": true + }, + "email_address": { + "type": "string", + "title": "Email Address", + "description": "Email address for a subscriber.", + "readOnly": true + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "vip": { + "type": "boolean", + "title": "VIP", + "description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.", + "readOnly": true + }, + "clicks": { + "type": "integer", + "title": "Total Clicks", + "description": "The total number of times the subscriber clicked on the link.", + "readOnly": true + }, + "campaign_id": { + "type": "string", + "title": "Campaign ID", + "description": "The campaign id.", + "readOnly": true + }, + "url_id": { + "type": "string", + "title": "URL ID", + "description": "The id for the tracked URL in the campaign.", + "readOnly": true + }, + "list_id": { + "type": "string", + "title": "List ID", + "description": "The list id.", + "readOnly": true + }, + "list_is_active": { + "type": "boolean", + "title": "List Status", + "description": "The status of the list used, namely if it's deleted or disabled.", + "readOnly": true + }, + "contact_status": { + "type": "string", + "title": "Member Status", + "description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "reports" + ], + "x-custom-config": { + "methodNameSnake": "get_subscriber_info", + "methodNameCamel": "getSubscriberInfo" + } + } + }, + "/reports/{campaign_id}/open-details": { + "get": { + "summary": "List campaign open details", + "description": "Get detailed information about any campaign emails that were opened by a list member.", + "operationId": "getReportsIdOpenDetails", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "count", + "x-title": "Count", + "in": "query", + "description": "The number of records to return. Default value is 10. Maximum value is 1000", + "required": false, + "default": 10, + "maximum": 1000, + "type": "integer" + }, + { + "name": "offset", + "x-title": "Offset", + "in": "query", + "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.", + "required": false, + "default": 0, + "type": "integer" + }, + { + "in": "path", + "name": "campaign_id", + "x-title": "Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the campaign." + }, + { + "name": "since", + "x-title": "Campaign opens since", "in": "query", - "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "in": "path", - "name": "campaign_id", - "x-title": "Campaign ID", - "type": "string", - "required": true, - "description": "The unique id for the campaign." - }, - { - "name": "link_id", - "x-title": "Link ID", - "description": "The id for the link.", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "subscriber_hash", - "x-title": "Subscriber Hash", + "description": "Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.", "type": "string", - "required": true, - "description": "The MD5 hash of the lowercase version of the list member's email address." - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "type": "object", - "title": "Click Detail Member", - "description": "A subscriber who clicked a specific URL in a specific campaign.", - "properties": { - "email_id": { - "type": "string", - "title": "Email Hash", - "description": "The MD5 hash of the lowercase version of the list member's email address.", - "readOnly": true - }, - "email_address": { - "type": "string", - "title": "Email Address", - "description": "Email address for a subscriber.", - "readOnly": true - }, - "merge_fields": { - "type": "object", - "title": "Merge Fields", - "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", - "additionalProperties": { - "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." - } - }, - "vip": { - "type": "boolean", - "title": "VIP", - "description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.", - "readOnly": true - }, - "clicks": { - "type": "integer", - "title": "Total Clicks", - "description": "The total number of times the subscriber clicked on the link.", - "readOnly": true - }, - "campaign_id": { - "type": "string", - "title": "Campaign ID", - "description": "The campaign id.", - "readOnly": true - }, - "url_id": { - "type": "string", - "title": "URL ID", - "description": "The id for the tracked URL in the campaign.", - "readOnly": true - }, - "list_id": { - "type": "string", - "title": "List ID", - "description": "The list id.", - "readOnly": true - }, - "list_is_active": { - "type": "boolean", - "title": "List Status", - "description": "The status of the list used, namely if it's deleted or disabled.", - "readOnly": true - }, - "contact_status": { - "type": "string", - "title": "Member Status", - "description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.", - "readOnly": true - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "default": { - "description": "An error generated by the Mailchimp API.", - "schema": { - "type": "object", - "title": "Problem Detail Document", - "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", - "required": [ - "type", - "title", - "status", - "detail", - "instance" - ], - "properties": { - "type": { - "type": "string", - "title": "Problem Type", - "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", - "example": "https://mailchimp.com/developer/marketing/docs/errors/" - }, - "title": { - "type": "string", - "title": "Error Title", - "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", - "example": "Resource Not Found" - }, - "status": { - "type": "integer", - "title": "HTTP Status Code", - "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", - "example": 404 - }, - "detail": { - "type": "string", - "title": "Error Message", - "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", - "example": "The requested resource could not be found." - }, - "instance": { - "type": "string", - "title": "Instance ID", - "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", - "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" - } - } - } - } - }, - "deprecated": false, - "tags": [ - "reports" - ], - "x-custom-config": { - "methodNameSnake": "get_subscriber_info", - "methodNameCamel": "getSubscriberInfo" - } - } - }, - "/reports/{campaign_id}/open-details": { - "get": { - "summary": "List campaign open details", - "description": "Get detailed information about any campaign emails that were opened by a list member.", - "operationId": "getReportsIdOpenDetails", - "parameters": [ - { - "name": "fields", - "x-title": "Fields", - "in": "query", - "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "exclude_fields", - "x-title": "Exclude Fields", - "in": "query", - "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "count", - "x-title": "Count", - "in": "query", - "description": "The number of records to return. Default value is 10. Maximum value is 1000", - "required": false, - "default": 10, - "maximum": 1000, - "type": "integer" + "x-example": "2016-04-12 12:00:00" }, { - "name": "offset", - "x-title": "Offset", + "name": "sort_field", + "x-title": "Sort By Field", + "description": "Returns open reports sorted by the specified field.", "in": "query", - "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.", "required": false, - "default": 0, - "type": "integer" - }, - { - "in": "path", - "name": "campaign_id", - "x-title": "Campaign ID", "type": "string", - "required": true, - "description": "The unique id for the campaign." + "enum": [ + "opens_count" + ] }, { - "name": "since", - "x-title": "Campaign opens since", + "name": "sort_dir", + "x-title": "Sort Direction", + "description": "Determines the order direction for sorted results.", "in": "query", "required": false, - "description": "Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.", "type": "string", - "x-example": "2016-04-12 12:00:00" + "enum": [ + "ASC", + "DESC" + ] } ], "responses": { @@ -88421,6 +92824,12 @@ "description": "The total number of times the this campaign was opened by the list member.", "readOnly": true }, + "proxy_excluded_opens_count": { + "type": "integer", + "title": "Proxy Excluded Opens count", + "description": "The total number of times the this campaign was opened by the list member excluding opens from email clients that use proxies .", + "readOnly": true + }, "opens": { "type": "array", "title": "Time series data of opens activity", @@ -88435,6 +92844,12 @@ "title": "Timestamp", "description": "The date and time recorded for the action in ISO 8601 format.", "format": "date-time" + }, + "is_proxy_open": { + "type": "boolean", + "title": "Proxy Open", + "description": "Indicates if the open was from an email client that use proxies.", + "readOnly": true } } } @@ -88507,6 +92922,11 @@ "title": "Total opens", "description": "The total number of opens matching the query regardless of pagination." }, + "total_proxy_excluded_opens": { + "type": "integer", + "title": "Total Proxy Excluded Opens", + "description": "The total number of opens excluding opens from email clients that use proxies regardless of pagination." + }, "total_items": { "type": "integer", "title": "Item Count", @@ -88737,6 +93157,12 @@ "description": "The total number of times the this campaign was opened by the list member.", "readOnly": true }, + "proxy_excluded_opens_count": { + "type": "integer", + "title": "Proxy Excluded Opens count", + "description": "The total number of times the this campaign was opened by the list member excluding opens from email clients that use proxies .", + "readOnly": true + }, "opens": { "type": "array", "title": "Time series data of opens activity", @@ -88751,6 +93177,12 @@ "title": "Timestamp", "description": "The date and time recorded for the action in ISO 8601 format.", "format": "date-time" + }, + "is_proxy_open": { + "type": "boolean", + "title": "Proxy Open", + "description": "Indicates if the open was from an email client that use proxies.", + "readOnly": true } } } @@ -89586,7 +94018,7 @@ "activity": { "type": "array", "title": "Member Activity", - "description": "An array of objects, each showing an interaction with the email.", + "description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign.", "items": { "type": "object", "title": "Member Activity", @@ -89899,7 +94331,7 @@ "activity": { "type": "array", "title": "Member Activity", - "description": "An array of objects, each showing an interaction with the email.", + "description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign.", "items": { "type": "object", "title": "Member Activity", @@ -90141,6 +94573,12 @@ "title": "Opens", "description": "The number of unique campaign opens for a region.", "readOnly": true + }, + "proxy_excluded_opens": { + "type": "integer", + "title": "Proxy Excluded Opens", + "description": "The number of unique campaign opens for a region excluding opens from email clients that use proxies.", + "readOnly": true } } }, @@ -90373,8 +94811,13 @@ }, "status": { "type": "string", - "title": "Member Status", - "description": "The status of the member ('sent', 'hard' for hard bounce, or 'soft' for soft bounce)." + "title": "Delivery Status", + "description": "The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/).", + "enum": [ + "sent", + "hard", + "soft" + ] }, "open_count": { "type": "integer", @@ -90390,7 +94833,12 @@ "absplit_group": { "type": "string", "title": "A/B Split Group", - "description": "For A/B Split Campaigns, the group the member was apart of ('a', 'b', or 'winner')." + "description": "For A/B Split Campaigns, the group the member was apart of.", + "enum": [ + "a", + "b", + "winner" + ] }, "gmt_offset": { "type": "integer", @@ -90680,8 +95128,13 @@ }, "status": { "type": "string", - "title": "Member Status", - "description": "The status of the member ('sent', 'hard' for hard bounce, or 'soft' for soft bounce)." + "title": "Delivery Status", + "description": "The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/).", + "enum": [ + "sent", + "hard", + "soft" + ] }, "open_count": { "type": "integer", @@ -90697,7 +95150,12 @@ "absplit_group": { "type": "string", "title": "A/B Split Group", - "description": "For A/B Split Campaigns, the group the member was apart of ('a', 'b', or 'winner')." + "description": "For A/B Split Campaigns, the group the member was apart of.", + "enum": [ + "a", + "b", + "winner" + ] }, "gmt_offset": { "type": "integer", @@ -91013,15 +95471,30 @@ "title": "Total Opens", "description": "The total number of opens for a campaign." }, + "proxy_excluded_opens": { + "type": "integer", + "title": "Proxy Excluded Opens", + "description": "The total number of opens for a campaign, excluding opens from email clients that use proxies." + }, "unique_opens": { "type": "integer", "title": "Unique Opens", - "description": "The total number of unique opens." + "description": "The total number of unique opens for a campaign." + }, + "proxy_excluded_unique_opens": { + "type": "integer", + "title": "Proxy Excluded Unique Opens", + "description": "The total number of unique opens for a campaign, excluding opens from email clients that use proxies." }, "open_rate": { "type": "number", "title": "Open Rate", - "description": "The number of unique opens divided by the total number of successful deliveries." + "description": "The number of unique opens for a campaign divided by the total number of successful deliveries." + }, + "proxy_excluded_open_rate": { + "type": "number", + "title": "Proxy Excluded Open Rate", + "description": "The average unique open rate for a campaign, excluding opens from email clients that use proxies." }, "last_open": { "type": "string", @@ -91148,7 +95621,13 @@ "open_rate": { "type": "number", "title": "Open Rate", - "description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list.", + "description": "The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list.", + "readOnly": true + }, + "proxy_excluded_open_rate": { + "type": "number", + "title": "Proxy Excluded Open Rate", + "description": "The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list, excluding opens from email clients that use proxies.", "readOnly": true }, "click_rate": { @@ -91345,6 +95824,11 @@ "title": "Unique Opens", "description": "The number of unique opens in the timeseries." }, + "proxy_excluded_unique_opens": { + "type": "integer", + "title": "Proxy Excluded Unique Opens", + "description": "The number of unique opens in the timeseries, excluding opens from email clients that use proxies." + }, "recipients_clicks": { "type": "integer", "title": "Recipient Clicks", @@ -92502,6 +96986,19 @@ "name" ] }, + { + "name": "content_type", + "x-title": "Content Type", + "in": "query", + "required": false, + "description": "Limit results based on how the template's content is put together. Only templates of type `user` can be filtered by `content_type`. If you want to retrieve saved templates created with the legacy email editor, then filter `content_type` to `template`. If you'd rather pull your saved templates for the new editor, filter to `multichannel`. For code your own templates, filter to `html`.", + "type": "string", + "enum": [ + "html", + "template", + "multichannel" + ] + }, { "name": "sort_dir", "x-title": "Sort Direction", @@ -93939,6 +98436,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -96951,6 +101453,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -97663,499 +102170,509 @@ "description": "The customer's email address.", "readOnly": true }, - "opt_in_status": { - "type": "boolean", - "title": "Opt-in Status", - "description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)." - }, - "company": { - "type": "string", - "title": "Company", - "description": "The customer's company." - }, - "first_name": { - "type": "string", - "title": "First Name", - "description": "The customer's first name." - }, - "last_name": { - "type": "string", - "title": "Last Name", - "description": "The customer's last name." - }, - "orders_count": { - "type": "integer", - "title": "Orders Count", - "description": "The customer's total order count.", - "readOnly": true, - "example": 4 - }, - "total_spent": { - "type": "number", - "title": "Total Spent", - "description": "The total amount the customer has spent.", - "readOnly": true, - "example": 100 - }, - "address": { - "type": "object", - "title": "Address", - "description": "The customer's address.", - "properties": { - "address1": { - "type": "string", - "title": "Address Field 1", - "description": "The mailing address of the customer.", - "example": "675 Ponce de Leon Ave NE" - }, - "address2": { - "type": "string", - "title": "Address Field 2", - "description": "An additional field for the customer's mailing address.", - "example": "Suite 5000" - }, - "city": { - "type": "string", - "title": "City ", - "description": "The city the customer is located in.", - "example": "Atlanta" - }, - "province": { - "type": "string", - "title": "Province", - "description": "The customer's state name or normalized province.", - "example": "Georgia" - }, - "province_code": { - "type": "string", - "title": "Province Code", - "description": "The two-letter code for the customer's province or state.", - "example": "GA" - }, - "postal_code": { - "type": "string", - "title": "Postal Code", - "description": "The customer's postal or zip code.", - "example": "30308" - }, - "country": { - "type": "string", - "title": "Country Code", - "description": "The customer's country.", - "example": "United States" - }, - "country_code": { - "type": "string", - "title": "Country Code", - "description": "The two-letter code for the customer's country.", - "example": "US" - } - } - }, - "created_at": { - "type": "string", - "title": "Creation Time", - "format": "date-time", - "description": "The date and time the customer was created in ISO 8601 format.", - "readOnly": true, - "example": "2015-07-15T19:28:00+00:00" - }, - "updated_at": { - "type": "string", - "title": "Update Time", - "format": "date-time", - "description": "The date and time the customer was last updated in ISO 8601 format.", - "readOnly": true, - "example": "2015-07-15T19:28:00+00:00" - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - }, - "campaign_id": { - "type": "string", - "title": "Campaign ID", - "description": "A string that uniquely identifies the campaign associated with a cart.", - "example": "839488a60b" - }, - "checkout_url": { - "type": "string", - "title": "Checkout URL", - "description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations." - }, - "currency_code": { - "type": "string", - "title": "Currency Code", - "description": "The three-letter ISO 4217 code for the currency that the cart uses." - }, - "order_total": { - "type": "number", - "title": "Order Total", - "description": "The order total for the cart." - }, - "tax_total": { - "type": "number", - "title": "Tax Total", - "description": "The total tax for the cart." - }, - "lines": { - "type": "array", - "title": "Cart Line Items", - "description": "An array of the cart's line items.", - "items": { - "type": "object", - "title": "E-commerce Cart Line Item", - "description": "Information about a specific cart line item.", - "properties": { - "id": { - "type": "string", - "title": "Cart Line Item Foreign ID", - "description": "A unique identifier for the cart line item.", - "readOnly": true - }, - "product_id": { - "type": "string", - "title": "Cart Line Product Foreign ID", - "description": "A unique identifier for the product associated with the cart line item." - }, - "product_title": { - "type": "string", - "title": "Cart Line Product Title", - "description": "The name of the product for the cart line item.", - "readOnly": true - }, - "product_variant_id": { - "type": "string", - "title": "Cart Line Product Variant Foreign ID", - "description": "A unique identifier for the product variant associated with the cart line item." - }, - "product_variant_title": { - "type": "string", - "title": "Cart Line Product Variant Title", - "description": "The name of the product variant for the cart line item.", - "readOnly": true - }, - "quantity": { - "type": "integer", - "title": "Quantity", - "description": "The quantity of a cart line item." - }, - "price": { - "type": "number", - "title": "Price", - "description": "The price of a cart line item." - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "created_at": { - "type": "string", - "title": "Creation Time", - "format": "date-time", - "description": "The date and time the cart was created in ISO 8601 format.", - "readOnly": true, - "example": "2015-07-15T19:28:00+00:00" - }, - "updated_at": { - "type": "string", - "title": "Update Time", - "format": "date-time", - "description": "The date and time the cart was last updated in ISO 8601 format.", - "readOnly": true, - "example": "2015-07-15T19:28:00+00:00" - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "default": { - "description": "An error generated by the Mailchimp API.", - "schema": { - "type": "object", - "title": "Problem Detail Document", - "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", - "required": [ - "type", - "title", - "status", - "detail", - "instance" - ], - "properties": { - "type": { - "type": "string", - "title": "Problem Type", - "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", - "example": "https://mailchimp.com/developer/marketing/docs/errors/" - }, - "title": { - "type": "string", - "title": "Error Title", - "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", - "example": "Resource Not Found" - }, - "status": { - "type": "integer", - "title": "HTTP Status Code", - "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", - "example": 404 - }, - "detail": { - "type": "string", - "title": "Error Message", - "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", - "example": "The requested resource could not be found." - }, - "instance": { - "type": "string", - "title": "Instance ID", - "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", - "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" - } - } - } - } - }, - "deprecated": false, - "tags": [ - "ecommerce" - ], - "x-custom-config": { - "methodNameSnake": "add_store_cart", - "methodNameCamel": "addStoreCart" - } - } - }, - "/ecommerce/stores/{store_id}/carts/{cart_id}": { - "get": { - "summary": "Get cart info", - "description": "Get information about a specific cart.", - "operationId": "getEcommerceStoresIdCartsId", - "parameters": [ - { - "name": "fields", - "x-title": "Fields", - "in": "query", - "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "exclude_fields", - "x-title": "Exclude Fields", - "in": "query", - "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "store_id", - "x-title": "Store ID", - "description": "The store id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "cart_id", - "x-title": "Cart ID", - "description": "The id for the cart.", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "type": "object", - "title": "E-commerce Cart", - "description": "Information about a specific cart.", - "properties": { - "id": { - "type": "string", - "title": "Cart Foreign ID", - "description": "A unique identifier for the cart.", - "readOnly": true - }, - "customer": { - "type": "object", - "title": "E-commerce Customer", - "description": "Information about a specific customer.", - "properties": { - "id": { - "type": "string", - "title": "Customer Foreign ID", - "description": "A unique identifier for the customer.", - "readOnly": true - }, - "email_address": { + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, + "opt_in_status": { + "type": "boolean", + "title": "Opt-in Status", + "description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)." + }, + "company": { + "type": "string", + "title": "Company", + "description": "The customer's company." + }, + "first_name": { + "type": "string", + "title": "First Name", + "description": "The customer's first name." + }, + "last_name": { + "type": "string", + "title": "Last Name", + "description": "The customer's last name." + }, + "orders_count": { + "type": "integer", + "title": "Orders Count", + "description": "The customer's total order count.", + "readOnly": true, + "example": 4 + }, + "total_spent": { + "type": "number", + "title": "Total Spent", + "description": "The total amount the customer has spent.", + "readOnly": true, + "example": 100 + }, + "address": { + "type": "object", + "title": "Address", + "description": "The customer's address.", + "properties": { + "address1": { + "type": "string", + "title": "Address Field 1", + "description": "The mailing address of the customer.", + "example": "675 Ponce de Leon Ave NE" + }, + "address2": { + "type": "string", + "title": "Address Field 2", + "description": "An additional field for the customer's mailing address.", + "example": "Suite 5000" + }, + "city": { + "type": "string", + "title": "City ", + "description": "The city the customer is located in.", + "example": "Atlanta" + }, + "province": { + "type": "string", + "title": "Province", + "description": "The customer's state name or normalized province.", + "example": "Georgia" + }, + "province_code": { + "type": "string", + "title": "Province Code", + "description": "The two-letter code for the customer's province or state.", + "example": "GA" + }, + "postal_code": { + "type": "string", + "title": "Postal Code", + "description": "The customer's postal or zip code.", + "example": "30308" + }, + "country": { + "type": "string", + "title": "Country Code", + "description": "The customer's country.", + "example": "United States" + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The two-letter code for the customer's country.", + "example": "US" + } + } + }, + "created_at": { + "type": "string", + "title": "Creation Time", + "format": "date-time", + "description": "The date and time the customer was created in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "updated_at": { + "type": "string", + "title": "Update Time", + "format": "date-time", + "description": "The date and time the customer was last updated in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + }, + "campaign_id": { + "type": "string", + "title": "Campaign ID", + "description": "A string that uniquely identifies the campaign associated with a cart.", + "example": "839488a60b" + }, + "checkout_url": { + "type": "string", + "title": "Checkout URL", + "description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations." + }, + "currency_code": { + "type": "string", + "title": "Currency Code", + "description": "The three-letter ISO 4217 code for the currency that the cart uses." + }, + "order_total": { + "type": "number", + "title": "Order Total", + "description": "The order total for the cart." + }, + "tax_total": { + "type": "number", + "title": "Tax Total", + "description": "The total tax for the cart." + }, + "lines": { + "type": "array", + "title": "Cart Line Items", + "description": "An array of the cart's line items.", + "items": { + "type": "object", + "title": "E-commerce Cart Line Item", + "description": "Information about a specific cart line item.", + "properties": { + "id": { + "type": "string", + "title": "Cart Line Item Foreign ID", + "description": "A unique identifier for the cart line item.", + "readOnly": true + }, + "product_id": { + "type": "string", + "title": "Cart Line Product Foreign ID", + "description": "A unique identifier for the product associated with the cart line item." + }, + "product_title": { + "type": "string", + "title": "Cart Line Product Title", + "description": "The name of the product for the cart line item.", + "readOnly": true + }, + "product_variant_id": { + "type": "string", + "title": "Cart Line Product Variant Foreign ID", + "description": "A unique identifier for the product variant associated with the cart line item." + }, + "product_variant_title": { + "type": "string", + "title": "Cart Line Product Variant Title", + "description": "The name of the product variant for the cart line item.", + "readOnly": true + }, + "quantity": { + "type": "integer", + "title": "Quantity", + "description": "The quantity of a cart line item." + }, + "price": { + "type": "number", + "title": "Price", + "description": "The price of a cart line item." + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "created_at": { + "type": "string", + "title": "Creation Time", + "format": "date-time", + "description": "The date and time the cart was created in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "updated_at": { + "type": "string", + "title": "Update Time", + "format": "date-time", + "description": "The date and time the cart was last updated in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "ecommerce" + ], + "x-custom-config": { + "methodNameSnake": "add_store_cart", + "methodNameCamel": "addStoreCart" + } + } + }, + "/ecommerce/stores/{store_id}/carts/{cart_id}": { + "get": { + "summary": "Get cart info", + "description": "Get information about a specific cart.", + "operationId": "getEcommerceStoresIdCartsId", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "store_id", + "x-title": "Store ID", + "description": "The store id.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "cart_id", + "x-title": "Cart ID", + "description": "The id for the cart.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "E-commerce Cart", + "description": "Information about a specific cart.", + "properties": { + "id": { + "type": "string", + "title": "Cart Foreign ID", + "description": "A unique identifier for the cart.", + "readOnly": true + }, + "customer": { + "type": "object", + "title": "E-commerce Customer", + "description": "Information about a specific customer.", + "properties": { + "id": { + "type": "string", + "title": "Customer Foreign ID", + "description": "A unique identifier for the customer.", + "readOnly": true + }, + "email_address": { + "type": "string", + "title": "Email Address", + "description": "The customer's email address.", + "readOnly": true + }, + "sms_phone_number": { "type": "string", - "title": "Email Address", - "description": "The customer's email address.", - "readOnly": true + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." }, "opt_in_status": { "type": "boolean", @@ -98778,6 +103295,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -100433,6 +104955,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -100735,7 +105262,6 @@ "description": "Information about a specific customer.", "required": [ "id", - "email_address", "opt_in_status" ], "properties": { @@ -100750,6 +105276,11 @@ "title": "Email Address", "description": "The customer's email address." }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -100849,6 +105380,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -101134,6 +105670,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -101383,7 +105924,6 @@ "description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body.", "required": [ "id", - "email_address", "opt_in_status" ], "properties": { @@ -101398,6 +105938,11 @@ "title": "Email Address", "description": "The customer's email address." }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -101497,6 +106042,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -101844,6 +106394,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -104622,6 +109177,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -105196,37 +109756,1401 @@ "example": "Freddie's Jokes", "readOnly": true }, - "type": { + "type": { + "type": "string", + "title": "Outreach type", + "description": "The type of the outreach.", + "example": "regular", + "readOnly": true + }, + "published_time": { + "type": "string", + "format": "date-time", + "title": "Outreach published time", + "description": "The date and time the Outreach was published in ISO 8601 format.", + "example": "2017-06-06T13:56:12+00:00", + "readOnly": true + } + } + }, + "tracking_number": { + "type": "string", + "title": "Tracking number", + "description": "The tracking number associated with the order." + }, + "tracking_carrier": { + "type": "string", + "title": "Tracking carrier", + "description": "The tracking carrier associated with the order." + }, + "tracking_url": { + "type": "string", + "title": "Tracking URL", + "description": "The tracking URL associated with the order." + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "total_items": { + "type": "integer", + "title": "Item Count", + "description": "The total number of items matching the query regardless of pagination.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "ecommerce" + ], + "x-custom-config": { + "methodNameSnake": "get_store_orders", + "methodNameCamel": "getStoreOrders" + } + }, + "post": { + "summary": "Add order", + "description": "Add a new order to a store.", + "operationId": "postEcommerceStoresIdOrders", + "parameters": [ + { + "name": "store_id", + "x-title": "Store ID", + "description": "The store id.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": true, + "schema": { + "type": "object", + "title": "E-commerce Order", + "description": "Information about a specific order.", + "required": [ + "id", + "customer", + "currency_code", + "order_total", + "lines" + ], + "properties": { + "id": { + "type": "string", + "title": "Order Foreign ID", + "description": "A unique identifier for the order." + }, + "customer": { + "type": "object", + "title": "E-commerce Customer", + "description": "Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body.", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "title": "Customer Foreign ID", + "description": "A unique identifier for the customer. Limited to 50 characters.", + "maxLength": 50 + }, + "email_address": { + "type": "string", + "title": "Email Address", + "description": "The customer's email address." + }, + "opt_in_status": { + "type": "boolean", + "title": "Opt-in Status", + "description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)." + }, + "company": { + "type": "string", + "title": "Company", + "description": "The customer's company." + }, + "first_name": { + "type": "string", + "title": "First Name", + "description": "The customer's first name." + }, + "last_name": { + "type": "string", + "title": "Last Name", + "description": "The customer's last name." + }, + "address": { + "type": "object", + "title": "Address", + "description": "The customer's address.", + "properties": { + "address1": { + "type": "string", + "title": "Address Field 1", + "description": "The mailing address of the customer.", + "example": "675 Ponce de Leon Ave NE" + }, + "address2": { + "type": "string", + "title": "Address Field 2", + "description": "An additional field for the customer's mailing address.", + "example": "Suite 5000" + }, + "city": { + "type": "string", + "title": "City ", + "description": "The city the customer is located in.", + "example": "Atlanta" + }, + "province": { + "type": "string", + "title": "Province", + "description": "The customer's state name or normalized province.", + "example": "Georgia" + }, + "province_code": { + "type": "string", + "title": "Province Code", + "description": "The two-letter code for the customer's province or state.", + "example": "GA" + }, + "postal_code": { + "type": "string", + "title": "Postal Code", + "description": "The customer's postal or zip code.", + "example": "30308" + }, + "country": { + "type": "string", + "title": "Country Code", + "description": "The customer's country.", + "example": "United States" + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The two-letter code for the customer's country.", + "example": "US" + } + } + } + } + }, + "campaign_id": { + "type": "string", + "title": "Campaign ID", + "description": "A string that uniquely identifies the campaign for an order.", + "example": "839488a60b" + }, + "landing_site": { + "type": "string", + "title": "Landing Site", + "description": "The URL for the page where the buyer landed when entering the shop.", + "example": "http://www.example.com?source=abc" + }, + "financial_status": { + "type": "string", + "title": "Financial Status", + "description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)." + }, + "fulfillment_status": { + "type": "string", + "title": "Fulfillment Status", + "description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)." + }, + "currency_code": { + "type": "string", + "title": "Currency Code", + "description": "The three-letter ISO 4217 code for the currency that the store accepts." + }, + "order_total": { + "type": "number", + "title": "Order Total", + "description": "The total for the order." + }, + "order_url": { + "type": "string", + "title": "Order URL", + "description": "The URL for the order." + }, + "discount_total": { + "type": "number", + "title": "Discount Total", + "description": "The total amount of the discounts to be applied to the price of the order." + }, + "tax_total": { + "type": "number", + "title": "Tax Total", + "description": "The tax total for the order." + }, + "shipping_total": { + "type": "number", + "title": "Shipping Total", + "description": "The shipping total for the order." + }, + "tracking_code": { + "type": "string", + "enum": [ + "prec" + ], + "title": "Tracking Code", + "description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs." + }, + "processed_at_foreign": { + "type": "string", + "title": "Foreign Processed Time", + "format": "date-time", + "description": "The date and time the order was processed in ISO 8601 format.", + "example": "2015-07-15T19:28:00+00:00" + }, + "cancelled_at_foreign": { + "type": "string", + "title": "Foreign Cancel Time", + "format": "date-time", + "description": "The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being created.", + "example": "2015-07-15T19:28:00+00:00" + }, + "updated_at_foreign": { + "type": "string", + "title": "Foreign Update Time", + "format": "date-time", + "description": "The date and time the order was updated in ISO 8601 format.", + "example": "2015-07-15T19:28:00+00:00" + }, + "shipping_address": { + "type": "object", + "title": "Shipping Address", + "description": "The shipping address for the order.", + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The name associated with an order's shipping address.", + "example": "Freddie Chimpenheimer" + }, + "address1": { + "type": "string", + "title": "Address Field 1", + "description": "The shipping address for the order.", + "example": "675 Ponce de Leon Ave NE" + }, + "address2": { + "type": "string", + "title": "Address Field 2", + "description": "An additional field for the shipping address.", + "example": "Suite 5000" + }, + "city": { + "type": "string", + "title": "City ", + "description": "The city in the order's shipping address.", + "example": "Atlanta" + }, + "province": { + "type": "string", + "title": "Province", + "description": "The state or normalized province in the order's shipping address.", + "example": "Georgia" + }, + "province_code": { + "type": "string", + "title": "Province Code", + "description": "The two-letter code for the province or state in the shipping address.", + "example": "GA" + }, + "postal_code": { + "type": "string", + "title": "Postal Code", + "description": "The postal or zip code in the shipping address.", + "example": "30308" + }, + "country": { + "type": "string", + "title": "Country Code", + "description": "The country in the shipping address.", + "example": "United States" + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The two-letter code for the country in the shipping address.", + "example": "US" + }, + "longitude": { + "type": "number", + "title": "Longitude", + "description": "The longitude for the shipping address location.", + "example": -75.68903000000000247382558882236480712890625 + }, + "latitude": { + "type": "number", + "title": "Latitude", + "description": "The latitude for the shipping address location.", + "example": 45.4274079999999997880877344869077205657958984375 + }, + "phone": { + "type": "string", + "title": "Phone Number", + "description": "The phone number for the order's shipping address.", + "example": "8675309" + }, + "company": { + "type": "string", + "title": "Company", + "description": "The company associated with the shipping address." + } + } + }, + "billing_address": { + "type": "object", + "title": "Billing Address", + "description": "The billing address for the order.", + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The name associated with the billing address.", + "example": "Freddie Chimpenheimer" + }, + "address1": { + "type": "string", + "title": "Address Field 1", + "description": "The billing address for the order.", + "example": "675 Ponce de Leon Ave NE" + }, + "address2": { + "type": "string", + "title": "Address Field 2", + "description": "An additional field for the billing address.", + "example": "Suite 5000" + }, + "city": { + "type": "string", + "title": "City ", + "description": "The city in the billing address.", + "example": "Atlanta" + }, + "province": { + "type": "string", + "title": "Province", + "description": "The state or normalized province in the billing address.", + "example": "Georgia" + }, + "province_code": { + "type": "string", + "title": "Province Code", + "description": "The two-letter code for the province in the billing address.", + "example": "GA" + }, + "postal_code": { + "type": "string", + "title": "Postal Code", + "description": "The postal or zip code in the billing address.", + "example": "30308" + }, + "country": { + "type": "string", + "title": "Country Code", + "description": "The country in the billing address.", + "example": "United States" + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The two-letter code for the country in the billing address.", + "example": "US" + }, + "longitude": { + "type": "number", + "title": "Longitude", + "description": "The longitude for the billing address location.", + "example": -75.68903000000000247382558882236480712890625 + }, + "latitude": { + "type": "number", + "title": "Latitude", + "description": "The latitude for the billing address location.", + "example": 45.4274079999999997880877344869077205657958984375 + }, + "phone": { + "type": "string", + "title": "Phone Number", + "description": "The phone number for the billing address", + "example": "8675309" + }, + "company": { + "type": "string", + "title": "Company", + "description": "The company associated with the billing address." + } + } + }, + "promos": { + "type": "array", + "title": "Promos", + "description": "The promo codes applied on the order", + "items": { + "type": "object", + "required": [ + "code", + "type", + "amount_discounted" + ], + "properties": { + "code": { + "type": "string", + "title": "Code", + "description": "The Promo Code" + }, + "amount_discounted": { + "type": "number", + "title": "Amount Discounted", + "description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0" + }, + "type": { + "type": "string", + "title": "Type", + "description": "Type of discount. For free shipping set type to fixed", + "enum": [ + "fixed", + "percentage" + ] + } + } + } + }, + "lines": { + "type": "array", + "title": "Order Line Items", + "description": "An array of the order's line items.", + "items": { + "type": "object", + "title": "E-commerce Order Line Item", + "description": "Information about a specific order line.", + "required": [ + "id", + "product_id", + "product_variant_id", + "quantity", + "price" + ], + "properties": { + "id": { + "type": "string", + "title": "Order Line Item Foreign ID", + "description": "A unique identifier for the order line item." + }, + "product_id": { + "type": "string", + "title": "Order Line Item Product Foreign ID", + "description": "A unique identifier for the product associated with the order line item." + }, + "product_variant_id": { + "type": "string", + "title": "Order Line Item Product Variant Foreign ID", + "description": "A unique identifier for the product variant associated with the order line item." + }, + "product": { + "type": "object", + "title": "E-commerce Product", + "description": "Information about a specific product.", + "required": [ + "id", + "title", + "variants" + ], + "properties": { + "id": { + "type": "string", + "title": "Product Foreign ID", + "description": "A unique identifier for the product." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product.", + "example": "Cat Hat" + }, + "handle": { + "type": "string", + "title": "Handle", + "description": "The handle of a product.", + "example": "cat-hat" + }, + "url": { + "type": "string", + "title": "Product URL", + "description": "The URL for a product." + }, + "description": { + "type": "string", + "title": "Description", + "description": "The description of a product.", + "example": "This is a cat hat." + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of product.", + "example": "Accessories" + }, + "vendor": { + "type": "string", + "title": "Vendor", + "description": "The vendor for a product." + }, + "image_url": { + "type": "string", + "title": "Product Image URL", + "description": "The image URL for a product." + }, + "variants": { + "type": "array", + "title": "Product Variants", + "description": "An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product.", + "items": { + "type": "object", + "title": "E-commerce Product Variant", + "description": "Information about a specific product variant.", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string", + "title": "Product Variant Foreign ID", + "description": "A unique identifier for the product variant." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product variant.", + "example": "Cat Hat" + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product variant." + }, + "sku": { + "type": "string", + "title": "SKU", + "description": "The stock keeping unit (SKU) of a product variant." + }, + "price": { + "type": "number", + "title": "Price", + "description": "The price of a product variant." + }, + "inventory_quantity": { + "type": "integer", + "title": "Inventory Quantity", + "description": "The inventory quantity of a product variant." + }, + "image_url": { + "type": "string", + "title": "Image URL", + "description": "The image URL for a product variant." + }, + "backorders": { + "type": "string", + "title": "Backorders", + "description": "The backorders of a product variant." + }, + "visibility": { + "type": "string", + "title": "Visibility", + "description": "The visibility of a product variant." + } + } + } + }, + "images": { + "type": "array", + "title": "Product Images", + "description": "An array of the product's images.", + "items": { + "type": "object", + "title": "E-commerce Product Image", + "description": "Information about a specific product image.", + "required": [ + "id", + "url" + ], + "properties": { + "id": { + "type": "string", + "title": "Image Foreign ID", + "description": "A unique identifier for the product image." + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product image." + }, + "variant_ids": { + "type": "array", + "title": "Product Variants", + "description": "The list of product variants using the image.", + "items": { + "type": "string" + } + } + } + } + }, + "published_at_foreign": { + "type": "string", + "title": "Foreign Publish Time", + "format": "date-time", + "description": "The date and time the product was published.", + "example": "2015-07-15T19:28:00+00:00" + } + } + }, + "quantity": { + "type": "integer", + "title": "Quantity", + "description": "The quantity of an order line item." + }, + "price": { + "type": "number", + "title": "Price", + "description": "The price of an order line item." + }, + "discount": { + "type": "number", + "title": "Discount", + "description": "The total discount amount applied to this line item." + } + } + } + }, + "outreach": { + "type": "object", + "title": "Outreach", + "description": "The outreach associated with this order. For example, an email campaign or Facebook ad.", + "properties": { + "id": { + "type": "string", + "title": "Outreach ID", + "description": "A unique identifier for the outreach. Can be an email campaign ID.", + "example": "839488a60b" + } + } + }, + "tracking_number": { + "type": "string", + "title": "Tracking number", + "description": "The tracking number associated with the order." + }, + "tracking_carrier": { + "type": "string", + "title": "Tracking carrier", + "description": "The tracking carrier associated with the order." + }, + "tracking_url": { + "type": "string", + "title": "Tracking URL", + "description": "The tracking URL associated with the order." + } + } + } + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "E-commerce Order", + "description": "Information about a specific order.", + "properties": { + "id": { + "type": "string", + "title": "Order Foreign ID", + "description": "A unique identifier for the order.", + "readOnly": true + }, + "customer": { + "type": "object", + "title": "E-commerce Customer", + "description": "Information about a specific customer.", + "properties": { + "id": { + "type": "string", + "title": "Customer Foreign ID", + "description": "A unique identifier for the customer.", + "readOnly": true + }, + "email_address": { + "type": "string", + "title": "Email Address", + "description": "The customer's email address.", + "readOnly": true + }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, + "opt_in_status": { + "type": "boolean", + "title": "Opt-in Status", + "description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)." + }, + "company": { + "type": "string", + "title": "Company", + "description": "The customer's company." + }, + "first_name": { + "type": "string", + "title": "First Name", + "description": "The customer's first name." + }, + "last_name": { + "type": "string", + "title": "Last Name", + "description": "The customer's last name." + }, + "orders_count": { + "type": "integer", + "title": "Orders Count", + "description": "The customer's total order count.", + "readOnly": true, + "example": 4 + }, + "total_spent": { + "type": "number", + "title": "Total Spent", + "description": "The total amount the customer has spent.", + "readOnly": true, + "example": 100 + }, + "address": { + "type": "object", + "title": "Address", + "description": "The customer's address.", + "properties": { + "address1": { + "type": "string", + "title": "Address Field 1", + "description": "The mailing address of the customer.", + "example": "675 Ponce de Leon Ave NE" + }, + "address2": { + "type": "string", + "title": "Address Field 2", + "description": "An additional field for the customer's mailing address.", + "example": "Suite 5000" + }, + "city": { + "type": "string", + "title": "City ", + "description": "The city the customer is located in.", + "example": "Atlanta" + }, + "province": { + "type": "string", + "title": "Province", + "description": "The customer's state name or normalized province.", + "example": "Georgia" + }, + "province_code": { + "type": "string", + "title": "Province Code", + "description": "The two-letter code for the customer's province or state.", + "example": "GA" + }, + "postal_code": { + "type": "string", + "title": "Postal Code", + "description": "The customer's postal or zip code.", + "example": "30308" + }, + "country": { + "type": "string", + "title": "Country Code", + "description": "The customer's country.", + "example": "United States" + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The two-letter code for the customer's country.", + "example": "US" + } + } + }, + "created_at": { + "type": "string", + "title": "Creation Time", + "format": "date-time", + "description": "The date and time the customer was created in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "updated_at": { + "type": "string", + "title": "Update Time", + "format": "date-time", + "description": "The date and time the customer was last updated in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { "type": "string", - "title": "Outreach type", - "description": "The type of the outreach.", - "example": "regular", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, - "published_time": { + "schema": { "type": "string", - "format": "date-time", - "title": "Outreach published time", - "description": "The date and time the Outreach was published in ISO 8601 format.", - "example": "2017-06-06T13:56:12+00:00", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, - "tracking_number": { + "readOnly": true + } + } + }, + "store_id": { + "type": "string", + "title": "Store Foreign ID", + "description": "The unique identifier for the store.", + "readOnly": true + }, + "campaign_id": { + "type": "string", + "title": "Campaign ID", + "description": "A string that uniquely identifies the campaign associated with an order.", + "example": "839488a60b" + }, + "landing_site": { + "type": "string", + "title": "Landing Site", + "description": "The URL for the page where the buyer landed when entering the shop.", + "example": "http://www.example.com?source=abc" + }, + "financial_status": { + "type": "string", + "title": "Financial Status", + "description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)." + }, + "fulfillment_status": { + "type": "string", + "title": "Fulfillment Status", + "description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)." + }, + "currency_code": { + "type": "string", + "title": "Currency Code", + "description": "The three-letter ISO 4217 code for the currency that the store accepts." + }, + "order_total": { + "type": "number", + "title": "Order Total", + "description": "The order total associated with an order." + }, + "order_url": { + "type": "string", + "title": "Order URL", + "description": "The URL for the order." + }, + "discount_total": { + "type": "number", + "title": "Discount Total", + "description": "The total amount of the discounts to be applied to the price of the order." + }, + "tax_total": { + "type": "number", + "title": "Tax Total", + "description": "The tax total associated with an order." + }, + "shipping_total": { + "type": "number", + "title": "Shipping Total", + "description": "The shipping total for the order." + }, + "tracking_code": { + "type": "string", + "enum": [ + "prec" + ], + "title": "Tracking Code", + "description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs." + }, + "processed_at_foreign": { + "type": "string", + "title": "Foreign Processed Time", + "format": "date-time", + "description": "The date and time the order was processed in ISO 8601 format.", + "example": "2015-07-15T19:28:00+00:00" + }, + "cancelled_at_foreign": { + "type": "string", + "title": "Foreign Cancel Time", + "format": "date-time", + "description": "The date and time the order was cancelled in ISO 8601 format.", + "example": "2015-07-15T19:28:00+00:00" + }, + "updated_at_foreign": { + "type": "string", + "title": "Foreign Update Time", + "format": "date-time", + "description": "The date and time the order was updated in ISO 8601 format.", + "example": "2015-07-15T19:28:00+00:00" + }, + "shipping_address": { + "type": "object", + "title": "Shipping Address", + "description": "The shipping address for the order.", + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The name associated with an order's shipping address.", + "example": "Freddie Chimpenheimer" + }, + "address1": { + "type": "string", + "title": "Address Field 1", + "description": "The shipping address for the order.", + "example": "675 Ponce de Leon Ave NE" + }, + "address2": { + "type": "string", + "title": "Address Field 2", + "description": "An additional field for the shipping address.", + "example": "Suite 5000" + }, + "city": { + "type": "string", + "title": "City ", + "description": "The city in the order's shipping address.", + "example": "Atlanta" + }, + "province": { + "type": "string", + "title": "Province", + "description": "The state or normalized province in the order's shipping address.", + "example": "Georgia" + }, + "province_code": { + "type": "string", + "title": "Province Code", + "description": "The two-letter code for the province or state the order's shipping address is located in.", + "example": "GA" + }, + "postal_code": { + "type": "string", + "title": "Postal Code", + "description": "The postal or zip code in the order's shipping address.", + "example": "30308" + }, + "country": { + "type": "string", + "title": "Country Code", + "description": "The country in the order's shipping address.", + "example": "United States" + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The two-letter code for the country in the shipping address.", + "example": "US" + }, + "longitude": { + "type": "number", + "title": "Longitude", + "description": "The longitude for the shipping address location.", + "example": -75.68903000000000247382558882236480712890625 + }, + "latitude": { + "type": "number", + "title": "Latitude", + "description": "The latitude for the shipping address location.", + "example": 45.4274079999999997880877344869077205657958984375 + }, + "phone": { + "type": "string", + "title": "Phone Number", + "description": "The phone number for the order's shipping address", + "example": "8675309" + }, + "company": { + "type": "string", + "title": "Company", + "description": "The company associated with an order's shipping address." + } + } + }, + "billing_address": { + "type": "object", + "title": "Billing Address", + "description": "The billing address for the order.", + "properties": { + "name": { + "type": "string", + "title": "Name", + "description": "The name associated with an order's billing address.", + "example": "Freddie Chimpenheimer" + }, + "address1": { + "type": "string", + "title": "Address Field 1", + "description": "The billing address for the order.", + "example": "675 Ponce de Leon Ave NE" + }, + "address2": { + "type": "string", + "title": "Address Field 2", + "description": "An additional field for the billing address.", + "example": "Suite 5000" + }, + "city": { + "type": "string", + "title": "City ", + "description": "The city in the billing address.", + "example": "Atlanta" + }, + "province": { + "type": "string", + "title": "Province", + "description": "The state or normalized province in the billing address.", + "example": "Georgia" + }, + "province_code": { + "type": "string", + "title": "Province Code", + "description": "The two-letter code for the province or state in the billing address.", + "example": "GA" + }, + "postal_code": { + "type": "string", + "title": "Postal Code", + "description": "The postal or zip code in the billing address.", + "example": "30308" + }, + "country": { + "type": "string", + "title": "Country Code", + "description": "The country in the billing address.", + "example": "United States" + }, + "country_code": { + "type": "string", + "title": "Country Code", + "description": "The two-letter code for the country in the billing address.", + "example": "US" + }, + "longitude": { + "type": "number", + "title": "Longitude", + "description": "The longitude for the billing address location.", + "example": -75.68903000000000247382558882236480712890625 + }, + "latitude": { + "type": "number", + "title": "Latitude", + "description": "The latitude for the billing address location.", + "example": 45.4274079999999997880877344869077205657958984375 + }, + "phone": { + "type": "string", + "title": "Phone Number", + "description": "The phone number for the billing address.", + "example": "8675309" + }, + "company": { + "type": "string", + "title": "Company", + "description": "The company associated with the billing address." + } + } + }, + "promos": { + "type": "array", + "title": "Promos", + "description": "The promo codes applied on the order", + "items": { + "type": "object", + "properties": { + "code": { "type": "string", - "title": "Tracking number", - "description": "The tracking number associated with the order." + "title": "Code", + "description": "The Promo Code" }, - "tracking_carrier": { + "amount_discounted": { + "type": "number", + "title": "Amount Discounted", + "description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0" + }, + "type": { "type": "string", - "title": "Tracking carrier", - "description": "The tracking carrier associated with the order." + "title": "Type", + "description": "Type of discount. For free shipping set type to fixed", + "enum": [ + "fixed", + "percentage" + ] + } + } + } + }, + "lines": { + "type": "array", + "title": "Order Line Items", + "description": "An array of the order's line items.", + "items": { + "type": "object", + "title": "E-commerce Order Line Item", + "description": "Information about a specific order line.", + "properties": { + "id": { + "type": "string", + "title": "Order Line Item Foreign ID", + "description": "A unique identifier for an order line item.", + "readOnly": true }, - "tracking_url": { + "product_id": { "type": "string", - "title": "Tracking URL", - "description": "The tracking URL associated with the order." + "title": "Order Line Item Product Foreign ID", + "description": "A unique identifier for the product associated with an order line item." + }, + "product_title": { + "type": "string", + "title": "Order Line Item Product Title", + "description": "The name of the product for an order line item.", + "readOnly": true + }, + "product_variant_id": { + "type": "string", + "title": "Order Line Item Product Variant Foreign ID", + "description": "A unique identifier for the product variant associated with an order line item." + }, + "product_variant_title": { + "type": "string", + "title": "Order Line Item Product Variant Title", + "description": "The name of the product variant for an order line item.", + "readOnly": true + }, + "image_url": { + "type": "string", + "title": "Product Image URL", + "description": "The image URL for a product.", + "readOnly": true + }, + "quantity": { + "type": "integer", + "title": "Quantity", + "description": "The order line item quantity." + }, + "price": { + "type": "number", + "title": "Price", + "description": "The order line item price." + }, + "discount": { + "type": "number", + "title": "Discount", + "description": "The total discount amount applied to a line item." }, "_links": { "title": "Links", @@ -105283,11 +111207,55 @@ } } }, - "total_items": { - "type": "integer", - "title": "Item Count", - "description": "The total number of items matching the query regardless of pagination.", - "readOnly": true + "outreach": { + "type": "object", + "title": "Outreach", + "description": "The outreach associated with this order. For example, an email campaign or Facebook ad.", + "properties": { + "id": { + "type": "string", + "title": "Outreach ID", + "description": "A unique identifier for the outreach. Can be an email campaign ID.", + "example": "839488a60b" + }, + "name": { + "type": "string", + "title": "Outreach name", + "description": "The name for the outreach.", + "example": "Freddie's Jokes", + "readOnly": true + }, + "type": { + "type": "string", + "title": "Outreach type", + "description": "The type of the outreach.", + "example": "regular", + "readOnly": true + }, + "published_time": { + "type": "string", + "format": "date-time", + "title": "Outreach published time", + "description": "The date and time the Outreach was published in ISO 8601 format.", + "example": "2017-06-06T13:56:12+00:00", + "readOnly": true + } + } + }, + "tracking_number": { + "type": "string", + "title": "Tracking number", + "description": "The tracking number associated with the order." + }, + "tracking_carrier": { + "type": "string", + "title": "Tracking carrier", + "description": "The tracking carrier associated with the order." + }, + "tracking_url": { + "type": "string", + "title": "Tracking URL", + "description": "The tracking URL associated with the order." }, "_links": { "title": "Links", @@ -105397,15 +111365,41 @@ "ecommerce" ], "x-custom-config": { - "methodNameSnake": "get_store_orders", - "methodNameCamel": "getStoreOrders" + "methodNameSnake": "add_store_order", + "methodNameCamel": "addStoreOrder" } - }, - "post": { - "summary": "Add order", - "description": "Add a new order to a store.", - "operationId": "postEcommerceStoresIdOrders", + } + }, + "/ecommerce/stores/{store_id}/orders/{order_id}": { + "get": { + "summary": "Get order info", + "description": "Get information about a specific order.", + "operationId": "getEcommerceStoresIdOrdersId", "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, { "name": "store_id", "x-title": "Store ID", @@ -105415,45 +111409,49 @@ "type": "string" }, { - "name": "body", - "in": "body", - "description": "", + "name": "order_id", + "x-title": "Order ID", + "description": "The id for the order in a store.", + "in": "path", "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "", "schema": { "type": "object", "title": "E-commerce Order", "description": "Information about a specific order.", - "required": [ - "id", - "customer", - "currency_code", - "order_total", - "lines" - ], "properties": { "id": { "type": "string", "title": "Order Foreign ID", - "description": "A unique identifier for the order." + "description": "A unique identifier for the order.", + "readOnly": true }, "customer": { "type": "object", "title": "E-commerce Customer", - "description": "Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body.", - "required": [ - "id" - ], + "description": "Information about a specific customer.", "properties": { "id": { "type": "string", "title": "Customer Foreign ID", - "description": "A unique identifier for the customer. Limited to 50 characters.", - "maxLength": 50 + "description": "A unique identifier for the customer.", + "readOnly": true }, "email_address": { "type": "string", "title": "Email Address", - "description": "The customer's email address." + "description": "The customer's email address.", + "readOnly": true + }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." }, "opt_in_status": { "type": "boolean", @@ -105475,6 +111473,20 @@ "title": "Last Name", "description": "The customer's last name." }, + "orders_count": { + "type": "integer", + "title": "Orders Count", + "description": "The customer's total order count.", + "readOnly": true, + "example": 4 + }, + "total_spent": { + "type": "number", + "title": "Total Spent", + "description": "The total amount the customer has spent.", + "readOnly": true, + "example": 100 + }, "address": { "type": "object", "title": "Address", @@ -105529,13 +111541,87 @@ "example": "US" } } + }, + "created_at": { + "type": "string", + "title": "Creation Time", + "format": "date-time", + "description": "The date and time the customer was created in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "updated_at": { + "type": "string", + "title": "Update Time", + "format": "date-time", + "description": "The date and time the customer was last updated in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true } } }, + "store_id": { + "type": "string", + "title": "Store Foreign ID", + "description": "The unique identifier for the store.", + "readOnly": true + }, "campaign_id": { "type": "string", "title": "Campaign ID", - "description": "A string that uniquely identifies the campaign for an order.", + "description": "A string that uniquely identifies the campaign associated with an order.", "example": "839488a60b" }, "landing_site": { @@ -105562,7 +111648,7 @@ "order_total": { "type": "number", "title": "Order Total", - "description": "The total for the order." + "description": "The order total associated with an order." }, "order_url": { "type": "string", @@ -105577,7 +111663,7 @@ "tax_total": { "type": "number", "title": "Tax Total", - "description": "The tax total for the order." + "description": "The tax total associated with an order." }, "shipping_total": { "type": "number", @@ -105603,7 +111689,7 @@ "type": "string", "title": "Foreign Cancel Time", "format": "date-time", - "description": "The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being created.", + "description": "The date and time the order was cancelled in ISO 8601 format.", "example": "2015-07-15T19:28:00+00:00" }, "updated_at_foreign": { @@ -105651,19 +111737,19 @@ "province_code": { "type": "string", "title": "Province Code", - "description": "The two-letter code for the province or state in the shipping address.", + "description": "The two-letter code for the province or state the order's shipping address is located in.", "example": "GA" }, "postal_code": { "type": "string", "title": "Postal Code", - "description": "The postal or zip code in the shipping address.", + "description": "The postal or zip code in the order's shipping address.", "example": "30308" }, "country": { "type": "string", "title": "Country Code", - "description": "The country in the shipping address.", + "description": "The country in the order's shipping address.", "example": "United States" }, "country_code": { @@ -105687,13 +111773,13 @@ "phone": { "type": "string", "title": "Phone Number", - "description": "The phone number for the order's shipping address.", + "description": "The phone number for the order's shipping address", "example": "8675309" }, "company": { "type": "string", "title": "Company", - "description": "The company associated with the shipping address." + "description": "The company associated with an order's shipping address." } } }, @@ -105705,7 +111791,7 @@ "name": { "type": "string", "title": "Name", - "description": "The name associated with the billing address.", + "description": "The name associated with an order's billing address.", "example": "Freddie Chimpenheimer" }, "address1": { @@ -105735,7 +111821,7 @@ "province_code": { "type": "string", "title": "Province Code", - "description": "The two-letter code for the province in the billing address.", + "description": "The two-letter code for the province or state in the billing address.", "example": "GA" }, "postal_code": { @@ -105771,7 +111857,7 @@ "phone": { "type": "string", "title": "Phone Number", - "description": "The phone number for the billing address", + "description": "The phone number for the billing address.", "example": "8675309" }, "company": { @@ -105787,11 +111873,6 @@ "description": "The promo codes applied on the order", "items": { "type": "object", - "required": [ - "code", - "type", - "amount_discounted" - ], "properties": { "code": { "type": "string", @@ -105823,43 +111904,107 @@ "type": "object", "title": "E-commerce Order Line Item", "description": "Information about a specific order line.", - "required": [ - "id", - "product_id", - "product_variant_id", - "quantity", - "price" - ], "properties": { "id": { "type": "string", "title": "Order Line Item Foreign ID", - "description": "A unique identifier for the order line item." + "description": "A unique identifier for an order line item.", + "readOnly": true }, "product_id": { "type": "string", "title": "Order Line Item Product Foreign ID", - "description": "A unique identifier for the product associated with the order line item." + "description": "A unique identifier for the product associated with an order line item." + }, + "product_title": { + "type": "string", + "title": "Order Line Item Product Title", + "description": "The name of the product for an order line item.", + "readOnly": true }, "product_variant_id": { "type": "string", "title": "Order Line Item Product Variant Foreign ID", - "description": "A unique identifier for the product variant associated with the order line item." + "description": "A unique identifier for the product variant associated with an order line item." + }, + "product_variant_title": { + "type": "string", + "title": "Order Line Item Product Variant Title", + "description": "The name of the product variant for an order line item.", + "readOnly": true + }, + "image_url": { + "type": "string", + "title": "Product Image URL", + "description": "The image URL for a product.", + "readOnly": true }, "quantity": { "type": "integer", "title": "Quantity", - "description": "The quantity of an order line item." + "description": "The order line item quantity." }, "price": { "type": "number", "title": "Price", - "description": "The price of an order line item." + "description": "The order line item price." }, "discount": { "type": "number", "title": "Discount", - "description": "The total discount amount applied to this line item." + "description": "The total discount amount applied to a line item." + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true } } } @@ -105874,6 +112019,28 @@ "title": "Outreach ID", "description": "A unique identifier for the outreach. Can be an email campaign ID.", "example": "839488a60b" + }, + "name": { + "type": "string", + "title": "Outreach name", + "description": "The name for the outreach.", + "example": "Freddie's Jokes", + "readOnly": true + }, + "type": { + "type": "string", + "title": "Outreach type", + "description": "The type of the outreach.", + "example": "regular", + "readOnly": true + }, + "published_time": { + "type": "string", + "format": "date-time", + "title": "Outreach published time", + "description": "The date and time the Outreach was published in ISO 8601 format.", + "example": "2017-06-06T13:56:12+00:00", + "readOnly": true } } }, @@ -105891,41 +112058,176 @@ "type": "string", "title": "Tracking URL", "description": "The tracking URL associated with the order." + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } + }, + "deprecated": false, + "tags": [ + "ecommerce" ], - "responses": { - "200": { + "x-custom-config": { + "methodNameSnake": "get_order", + "methodNameCamel": "getOrder" + } + }, + "put": { + "summary": "Add or update order", + "description": "Add or update an order.", + "operationId": "putEcommerceStoresIdOrdersId", + "parameters": [ + { + "name": "store_id", + "x-title": "Store ID", + "description": "The store id.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "order_id", + "x-title": "Order ID", + "description": "The id for the order in a store.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", "description": "", + "required": true, "schema": { "type": "object", "title": "E-commerce Order", "description": "Information about a specific order.", + "required": [ + "id" + ], "properties": { "id": { "type": "string", "title": "Order Foreign ID", - "description": "A unique identifier for the order.", - "readOnly": true + "description": "A unique identifier for the order." }, "customer": { "type": "object", "title": "E-commerce Customer", - "description": "Information about a specific customer.", + "description": "Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body.", + "required": [ + "id" + ], "properties": { "id": { "type": "string", "title": "Customer Foreign ID", - "description": "A unique identifier for the customer.", - "readOnly": true + "description": "A unique identifier for the customer. Limited to 50 characters.", + "maxLength": 50 }, "email_address": { "type": "string", "title": "Email Address", - "description": "The customer's email address.", - "readOnly": true + "description": "The customer's email address." }, "opt_in_status": { "type": "boolean", @@ -105947,20 +112249,6 @@ "title": "Last Name", "description": "The customer's last name." }, - "orders_count": { - "type": "integer", - "title": "Orders Count", - "description": "The customer's total order count.", - "readOnly": true, - "example": 4 - }, - "total_spent": { - "type": "number", - "title": "Total Spent", - "description": "The total amount the customer has spent.", - "readOnly": true, - "example": 100 - }, "address": { "type": "object", "title": "Address", @@ -105970,13 +112258,12 @@ "type": "string", "title": "Address Field 1", "description": "The mailing address of the customer.", - "example": "675 Ponce de Leon Ave NE" + "example": "405 N Angier Ave NE" }, "address2": { "type": "string", "title": "Address Field 2", - "description": "An additional field for the customer's mailing address.", - "example": "Suite 5000" + "description": "An additional field for the customer's mailing address." }, "city": { "type": "string", @@ -106004,7 +112291,7 @@ }, "country": { "type": "string", - "title": "Country Code", + "title": "Country", "description": "The customer's country.", "example": "United States" }, @@ -106015,87 +112302,13 @@ "example": "US" } } - }, - "created_at": { - "type": "string", - "title": "Creation Time", - "format": "date-time", - "description": "The date and time the customer was created in ISO 8601 format.", - "readOnly": true, - "example": "2015-07-15T19:28:00+00:00" - }, - "updated_at": { - "type": "string", - "title": "Update Time", - "format": "date-time", - "description": "The date and time the customer was last updated in ISO 8601 format.", - "readOnly": true, - "example": "2015-07-15T19:28:00+00:00" - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true } } }, - "store_id": { - "type": "string", - "title": "Store Foreign ID", - "description": "The unique identifier for the store.", - "readOnly": true - }, "campaign_id": { "type": "string", "title": "Campaign ID", - "description": "A string that uniquely identifies the campaign associated with an order.", + "description": "A string that uniquely identifies the campaign for an order.", "example": "839488a60b" }, "landing_site": { @@ -106122,7 +112335,7 @@ "order_total": { "type": "number", "title": "Order Total", - "description": "The order total associated with an order." + "description": "The total for the order." }, "order_url": { "type": "string", @@ -106137,7 +112350,7 @@ "tax_total": { "type": "number", "title": "Tax Total", - "description": "The tax total associated with an order." + "description": "The tax total for the order." }, "shipping_total": { "type": "number", @@ -106157,21 +112370,21 @@ "title": "Foreign Processed Time", "format": "date-time", "description": "The date and time the order was processed in ISO 8601 format.", - "example": "2015-07-15T19:28:00+00:00" + "example": "2024-09-10T17:27:43+00:00" }, "cancelled_at_foreign": { "type": "string", "title": "Foreign Cancel Time", "format": "date-time", - "description": "The date and time the order was cancelled in ISO 8601 format.", - "example": "2015-07-15T19:28:00+00:00" + "description": "The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being created.", + "example": "2024-09-10T17:27:43+00:00" }, "updated_at_foreign": { "type": "string", "title": "Foreign Update Time", "format": "date-time", "description": "The date and time the order was updated in ISO 8601 format.", - "example": "2015-07-15T19:28:00+00:00" + "example": "2024-09-10T17:27:43+00:00" }, "shipping_address": { "type": "object", @@ -106188,13 +112401,12 @@ "type": "string", "title": "Address Field 1", "description": "The shipping address for the order.", - "example": "675 Ponce de Leon Ave NE" + "example": "405 N Angier Ave NE" }, "address2": { "type": "string", "title": "Address Field 2", - "description": "An additional field for the shipping address.", - "example": "Suite 5000" + "description": "An additional field for the shipping address." }, "city": { "type": "string", @@ -106211,19 +112423,19 @@ "province_code": { "type": "string", "title": "Province Code", - "description": "The two-letter code for the province or state the order's shipping address is located in.", + "description": "The two-letter code for the province or state in the shipping address.", "example": "GA" }, "postal_code": { "type": "string", "title": "Postal Code", - "description": "The postal or zip code in the order's shipping address.", + "description": "The postal or zip code in the shipping address.", "example": "30308" }, "country": { "type": "string", - "title": "Country Code", - "description": "The country in the order's shipping address.", + "title": "Country", + "description": "The country in the shipping address.", "example": "United States" }, "country_code": { @@ -106236,24 +112448,24 @@ "type": "number", "title": "Longitude", "description": "The longitude for the shipping address location.", - "example": -75.68903000000000247382558882236480712890625 + "example": -84.362887000000000625732354819774627685546875 }, "latitude": { "type": "number", "title": "Latitude", "description": "The latitude for the shipping address location.", - "example": 45.4274079999999997880877344869077205657958984375 + "example": 33.76852600000000137470124172978103160858154296875 }, "phone": { "type": "string", "title": "Phone Number", - "description": "The phone number for the order's shipping address", - "example": "8675309" + "description": "The phone number for the order's shipping address.", + "example": "+18004468848" }, "company": { "type": "string", "title": "Company", - "description": "The company associated with an order's shipping address." + "description": "The company associated with the shipping address." } } }, @@ -106265,20 +112477,19 @@ "name": { "type": "string", "title": "Name", - "description": "The name associated with an order's billing address.", + "description": "The name associated with the billing address.", "example": "Freddie Chimpenheimer" }, "address1": { "type": "string", "title": "Address Field 1", "description": "The billing address for the order.", - "example": "675 Ponce de Leon Ave NE" + "example": "405 N Angier Ave NE" }, "address2": { "type": "string", "title": "Address Field 2", - "description": "An additional field for the billing address.", - "example": "Suite 5000" + "description": "An additional field for the billing address." }, "city": { "type": "string", @@ -106295,7 +112506,7 @@ "province_code": { "type": "string", "title": "Province Code", - "description": "The two-letter code for the province or state in the billing address.", + "description": "The two-letter code for the province in the billing address.", "example": "GA" }, "postal_code": { @@ -106306,7 +112517,7 @@ }, "country": { "type": "string", - "title": "Country Code", + "title": "Country", "description": "The country in the billing address.", "example": "United States" }, @@ -106320,19 +112531,19 @@ "type": "number", "title": "Longitude", "description": "The longitude for the billing address location.", - "example": -75.68903000000000247382558882236480712890625 + "example": -84.362887000000000625732354819774627685546875 }, "latitude": { "type": "number", "title": "Latitude", "description": "The latitude for the billing address location.", - "example": 45.4274079999999997880877344869077205657958984375 + "example": 33.76852600000000137470124172978103160858154296875 }, "phone": { "type": "string", "title": "Phone Number", - "description": "The phone number for the billing address.", - "example": "8675309" + "description": "The phone number for the billing address", + "example": "+18004468848" }, "company": { "type": "string", @@ -106347,6 +112558,11 @@ "description": "The promo codes applied on the order", "items": { "type": "object", + "required": [ + "code", + "type", + "amount_discounted" + ], "properties": { "code": { "type": "string", @@ -106378,107 +112594,196 @@ "type": "object", "title": "E-commerce Order Line Item", "description": "Information about a specific order line.", + "required": [ + "id" + ], "properties": { "id": { "type": "string", "title": "Order Line Item Foreign ID", - "description": "A unique identifier for an order line item.", - "readOnly": true + "description": "A unique identifier for the order line item." }, "product_id": { "type": "string", "title": "Order Line Item Product Foreign ID", - "description": "A unique identifier for the product associated with an order line item." - }, - "product_title": { - "type": "string", - "title": "Order Line Item Product Title", - "description": "The name of the product for an order line item.", - "readOnly": true + "description": "A unique identifier for the product associated with the order line item." }, "product_variant_id": { "type": "string", "title": "Order Line Item Product Variant Foreign ID", - "description": "A unique identifier for the product variant associated with an order line item." - }, - "product_variant_title": { - "type": "string", - "title": "Order Line Item Product Variant Title", - "description": "The name of the product variant for an order line item.", - "readOnly": true + "description": "A unique identifier for the product variant associated with the order line item." }, - "image_url": { - "type": "string", - "title": "Product Image URL", - "description": "The image URL for a product.", - "readOnly": true + "product": { + "type": "object", + "title": "E-commerce Product", + "description": "Information about a specific product.", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "title": "Product Foreign ID", + "description": "A unique identifier for the product." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product.", + "example": "Cat Hat" + }, + "handle": { + "type": "string", + "title": "Handle", + "description": "The handle of a product.", + "example": "cat-hat" + }, + "url": { + "type": "string", + "title": "Product URL", + "description": "The URL for a product." + }, + "description": { + "type": "string", + "title": "Description", + "description": "The description of a product.", + "example": "This is a cat hat." + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of product.", + "example": "Accessories" + }, + "vendor": { + "type": "string", + "title": "Vendor", + "description": "The vendor for a product." + }, + "image_url": { + "type": "string", + "title": "Product Image URL", + "description": "The image URL for a product." + }, + "variants": { + "type": "array", + "title": "Product Variants", + "description": "An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product.", + "items": { + "type": "object", + "title": "E-commerce Product Variant", + "description": "Information about a specific product variant.", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string", + "title": "Product Variant Foreign ID", + "description": "A unique identifier for the product variant." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product variant.", + "example": "Cat Hat" + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product variant." + }, + "sku": { + "type": "string", + "title": "SKU", + "description": "The stock keeping unit (SKU) of a product variant." + }, + "price": { + "type": "number", + "title": "Price", + "description": "The price of a product variant." + }, + "inventory_quantity": { + "type": "integer", + "title": "Inventory Quantity", + "description": "The inventory quantity of a product variant." + }, + "image_url": { + "type": "string", + "title": "Image URL", + "description": "The image URL for a product variant." + }, + "backorders": { + "type": "string", + "title": "Backorders", + "description": "The backorders of a product variant." + }, + "visibility": { + "type": "string", + "title": "Visibility", + "description": "The visibility of a product variant." + } + } + } + }, + "images": { + "type": "array", + "title": "Product Images", + "description": "An array of the product's images.", + "items": { + "type": "object", + "title": "E-commerce Product Image", + "description": "Information about a specific product image.", + "required": [ + "id", + "url" + ], + "properties": { + "id": { + "type": "string", + "title": "Image Foreign ID", + "description": "A unique identifier for the product image." + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product image." + }, + "variant_ids": { + "type": "array", + "title": "Product Variants", + "description": "The list of product variants using the image.", + "items": { + "type": "string" + } + } + } + } + }, + "published_at_foreign": { + "type": "string", + "title": "Foreign Publish Time", + "format": "date-time", + "description": "The date and time the product was published.", + "example": "2015-07-15T19:28:00+00:00" + } + } }, "quantity": { "type": "integer", "title": "Quantity", - "description": "The order line item quantity." + "description": "The quantity of an order line item." }, "price": { "type": "number", "title": "Price", - "description": "The order line item price." + "description": "The price of an order line item." }, "discount": { "type": "number", "title": "Discount", - "description": "The total discount amount applied to a line item." - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true + "description": "The total discount amount applied to this line item." } } } @@ -106493,28 +112798,6 @@ "title": "Outreach ID", "description": "A unique identifier for the outreach. Can be an email campaign ID.", "example": "839488a60b" - }, - "name": { - "type": "string", - "title": "Outreach name", - "description": "The name for the outreach.", - "example": "Freddie's Jokes", - "readOnly": true - }, - "type": { - "type": "string", - "title": "Outreach type", - "description": "The type of the outreach.", - "example": "regular", - "readOnly": true - }, - "published_time": { - "type": "string", - "format": "date-time", - "title": "Outreach published time", - "description": "The date and time the Outreach was published in ISO 8601 format.", - "example": "2017-06-06T13:56:12+00:00", - "readOnly": true } } }, @@ -106532,166 +112815,10 @@ "type": "string", "title": "Tracking URL", "description": "The tracking URL associated with the order." - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, - "default": { - "description": "An error generated by the Mailchimp API.", - "schema": { - "type": "object", - "title": "Problem Detail Document", - "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", - "required": [ - "type", - "title", - "status", - "detail", - "instance" - ], - "properties": { - "type": { - "type": "string", - "title": "Problem Type", - "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", - "example": "https://mailchimp.com/developer/marketing/docs/errors/" - }, - "title": { - "type": "string", - "title": "Error Title", - "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", - "example": "Resource Not Found" - }, - "status": { - "type": "integer", - "title": "HTTP Status Code", - "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", - "example": 404 - }, - "detail": { - "type": "string", - "title": "Error Message", - "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", - "example": "The requested resource could not be found." - }, - "instance": { - "type": "string", - "title": "Instance ID", - "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", - "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } - }, - "deprecated": false, - "tags": [ - "ecommerce" - ], - "x-custom-config": { - "methodNameSnake": "add_store_order", - "methodNameCamel": "addStoreOrder" - } - } - }, - "/ecommerce/stores/{store_id}/orders/{order_id}": { - "get": { - "summary": "Get order info", - "description": "Get information about a specific order.", - "operationId": "getEcommerceStoresIdOrdersId", - "parameters": [ - { - "name": "fields", - "x-title": "Fields", - "in": "query", - "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "exclude_fields", - "x-title": "Exclude Fields", - "in": "query", - "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "store_id", - "x-title": "Store ID", - "description": "The store id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "order_id", - "x-title": "Order ID", - "description": "The id for the order in a store.", - "in": "path", - "required": true, - "type": "string" - } ], "responses": { "200": { @@ -106724,6 +112851,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -107438,8 +113570,8 @@ "ecommerce" ], "x-custom-config": { - "methodNameSnake": "get_order", - "methodNameCamel": "getOrder" + "methodNameSnake": "set_order", + "methodNameCamel": "setOrder" } }, "patch": { @@ -107938,6 +114070,11 @@ "description": "The customer's email address.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, "opt_in_status": { "type": "boolean", "title": "Opt-in Status", @@ -109108,6 +115245,165 @@ "title": "Order Line Item Product Variant Foreign ID", "description": "A unique identifier for the product variant associated with the order line item." }, + "product": { + "type": "object", + "title": "E-commerce Product", + "description": "Information about a specific product.", + "required": [ + "id", + "title", + "variants" + ], + "properties": { + "id": { + "type": "string", + "title": "Product Foreign ID", + "description": "A unique identifier for the product." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product.", + "example": "Cat Hat" + }, + "handle": { + "type": "string", + "title": "Handle", + "description": "The handle of a product.", + "example": "cat-hat" + }, + "url": { + "type": "string", + "title": "Product URL", + "description": "The URL for a product." + }, + "description": { + "type": "string", + "title": "Description", + "description": "The description of a product.", + "example": "This is a cat hat." + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of product.", + "example": "Accessories" + }, + "vendor": { + "type": "string", + "title": "Vendor", + "description": "The vendor for a product." + }, + "image_url": { + "type": "string", + "title": "Product Image URL", + "description": "The image URL for a product." + }, + "variants": { + "type": "array", + "title": "Product Variants", + "description": "An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product.", + "items": { + "type": "object", + "title": "E-commerce Product Variant", + "description": "Information about a specific product variant.", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string", + "title": "Product Variant Foreign ID", + "description": "A unique identifier for the product variant." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product variant.", + "example": "Cat Hat" + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product variant." + }, + "sku": { + "type": "string", + "title": "SKU", + "description": "The stock keeping unit (SKU) of a product variant." + }, + "price": { + "type": "number", + "title": "Price", + "description": "The price of a product variant." + }, + "inventory_quantity": { + "type": "integer", + "title": "Inventory Quantity", + "description": "The inventory quantity of a product variant." + }, + "image_url": { + "type": "string", + "title": "Image URL", + "description": "The image URL for a product variant." + }, + "backorders": { + "type": "string", + "title": "Backorders", + "description": "The backorders of a product variant." + }, + "visibility": { + "type": "string", + "title": "Visibility", + "description": "The visibility of a product variant." + } + } + } + }, + "images": { + "type": "array", + "title": "Product Images", + "description": "An array of the product's images.", + "items": { + "type": "object", + "title": "E-commerce Product Image", + "description": "Information about a specific product image.", + "required": [ + "id", + "url" + ], + "properties": { + "id": { + "type": "string", + "title": "Image Foreign ID", + "description": "A unique identifier for the product image." + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product image." + }, + "variant_ids": { + "type": "array", + "title": "Product Variants", + "description": "The list of product variants using the image.", + "items": { + "type": "string" + } + } + } + } + }, + "published_at_foreign": { + "type": "string", + "title": "Foreign Publish Time", + "format": "date-time", + "description": "The date and time the product was published.", + "example": "2015-07-15T19:28:00+00:00" + } + } + }, "quantity": { "type": "integer", "title": "Quantity", @@ -110663,74 +116959,833 @@ "type": "string", "title": "Visibility", "description": "The visibility of a product variant." - }, - "created_at": { - "type": "string", - "title": "Creation Time", - "format": "date-time", - "description": "The date and time the product was created in ISO 8601 format.", - "readOnly": true, - "example": "2015-07-15T19:28:00+00:00" - }, - "updated_at": { - "type": "string", - "title": "Update Time", - "format": "date-time", - "description": "The date and time the product was last updated in ISO 8601 format.", - "readOnly": true, - "example": "2015-07-15T19:28:00+00:00" - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true + }, + "created_at": { + "type": "string", + "title": "Creation Time", + "format": "date-time", + "description": "The date and time the product was created in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "updated_at": { + "type": "string", + "title": "Update Time", + "format": "date-time", + "description": "The date and time the product was last updated in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "images": { + "type": "array", + "title": "Product Images", + "description": "An array of the product's images.", + "items": { + "type": "object", + "title": "E-commerce Product Image", + "description": "Information about a specific product image.", + "properties": { + "id": { + "type": "string", + "title": "Image Foreign ID", + "description": "A unique identifier for the product image." + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product image." + }, + "variant_ids": { + "type": "array", + "title": "Product Variants", + "description": "The list of product variants using the image.", + "items": { + "type": "string" + } + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "published_at_foreign": { + "type": "string", + "title": "Foreign Publish Time", + "format": "date-time", + "description": "The date and time the product was published in ISO 8601 format.", + "example": "2015-07-15T19:28:00+00:00" + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "ecommerce" + ], + "x-custom-config": { + "methodNameSnake": "add_store_product", + "methodNameCamel": "addStoreProduct" + } + } + }, + "/ecommerce/stores/{store_id}/products/{product_id}": { + "get": { + "summary": "Get product info", + "description": "Get information about a specific product.", + "operationId": "getEcommerceStoresIdProductsId", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "store_id", + "x-title": "Store ID", + "description": "The store id.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "product_id", + "x-title": "Product ID", + "description": "The id for the product of a store.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "E-commerce Product", + "description": "Information about a specific product.", + "properties": { + "id": { + "type": "string", + "title": "Product Foreign ID", + "description": "A unique identifier for the product.", + "readOnly": true + }, + "currency_code": { + "type": "string", + "title": "Currency Code", + "description": "The currency code", + "readOnly": true + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product.", + "example": "Cat Hat" + }, + "handle": { + "type": "string", + "title": "Handle", + "description": "The handle of a product.", + "example": "cat-hat" + }, + "url": { + "type": "string", + "title": "Product URL", + "description": "The URL for a product." + }, + "description": { + "type": "string", + "title": "Description", + "description": "The description of a product.", + "example": "This is a cat hat." + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of product.", + "example": "Accessories" + }, + "vendor": { + "type": "string", + "title": "Vendor", + "description": "The vendor for a product." + }, + "image_url": { + "type": "string", + "title": "Product Image URL", + "description": "The image URL for a product." + }, + "variants": { + "type": "array", + "title": "Product Variants", + "description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/).", + "items": { + "type": "object", + "title": "E-commerce Product Variant", + "description": "Information about a specific product variant.", + "properties": { + "id": { + "type": "string", + "title": "Product Variant Foreign ID", + "description": "A unique identifier for the product variant.", + "readOnly": true + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product variant.", + "example": "Cat Hat" + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product variant." + }, + "sku": { + "type": "string", + "title": "SKU", + "description": "The stock keeping unit (SKU) of a product variant." + }, + "price": { + "type": "number", + "title": "Price", + "description": "The price of a product variant." + }, + "inventory_quantity": { + "type": "integer", + "title": "Inventory Quantity", + "description": "The inventory quantity of a product variant." + }, + "image_url": { + "type": "string", + "title": "Image URL", + "description": "The image URL for a product variant." + }, + "backorders": { + "type": "string", + "title": "Backorders", + "description": "The backorders of a product variant." + }, + "visibility": { + "type": "string", + "title": "Visibility", + "description": "The visibility of a product variant." + }, + "created_at": { + "type": "string", + "title": "Creation Time", + "format": "date-time", + "description": "The date and time the product was created in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "updated_at": { + "type": "string", + "title": "Update Time", + "format": "date-time", + "description": "The date and time the product was last updated in ISO 8601 format.", + "readOnly": true, + "example": "2015-07-15T19:28:00+00:00" + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "images": { + "type": "array", + "title": "Product Images", + "description": "An array of the product's images.", + "items": { + "type": "object", + "title": "E-commerce Product Image", + "description": "Information about a specific product image.", + "properties": { + "id": { + "type": "string", + "title": "Image Foreign ID", + "description": "A unique identifier for the product image." + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product image." + }, + "variant_ids": { + "type": "array", + "title": "Product Variants", + "description": "The list of product variants using the image.", + "items": { + "type": "string" + } + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "published_at_foreign": { + "type": "string", + "title": "Foreign Publish Time", + "format": "date-time", + "description": "The date and time the product was published in ISO 8601 format.", + "example": "2015-07-15T19:28:00+00:00" + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "ecommerce" + ], + "x-custom-config": { + "methodNameSnake": "get_store_product", + "methodNameCamel": "getStoreProduct" + } + }, + "patch": { + "summary": "Update product", + "description": "Update a specific product.", + "operationId": "patchEcommerceStoresIdProductsId", + "parameters": [ + { + "name": "store_id", + "x-title": "Store ID", + "description": "The store id.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "product_id", + "x-title": "Product ID", + "description": "The id for the product of a store.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": true, + "schema": { + "type": "object", + "title": "E-commerce Product", + "description": "Information about a specific product.", + "properties": { + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product.", + "example": "Cat Hat" + }, + "handle": { + "type": "string", + "title": "Handle", + "description": "The handle of a product.", + "example": "cat-hat" + }, + "url": { + "type": "string", + "title": "Product URL", + "description": "The URL for a product." + }, + "description": { + "type": "string", + "title": "Description", + "description": "The description of a product.", + "example": "This is a cat hat." + }, + "type": { + "type": "string", + "title": "Type", + "description": "The type of product.", + "example": "Accessories" + }, + "vendor": { + "type": "string", + "title": "Vendor", + "description": "The vendor for a product." + }, + "image_url": { + "type": "string", + "title": "Product Image URL", + "description": "The image URL for a product." + }, + "variants": { + "type": "array", + "title": "Product Variants", + "description": "An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product.", + "items": { + "type": "object", + "title": "E-commerce Product Variant", + "description": "Information about a specific product variant.", + "properties": { + "title": { + "type": "string", + "title": "Title", + "description": "The title of a product variant.", + "example": "Cat Hat" + }, + "url": { + "type": "string", + "title": "URL", + "description": "The URL for a product variant." + }, + "sku": { + "type": "string", + "title": "SKU", + "description": "The stock keeping unit (SKU) of a product variant." + }, + "price": { + "type": "number", + "title": "Price", + "description": "The price of a product variant." + }, + "inventory_quantity": { + "type": "integer", + "title": "Inventory Quantity", + "description": "The inventory quantity of a product variant." + }, + "image_url": { + "type": "string", + "title": "Image URL", + "description": "The image URL for a product variant." + }, + "backorders": { + "type": "string", + "title": "Backorders", + "description": "The backorders of a product variant." + }, + "visibility": { + "type": "string", + "title": "Visibility", + "description": "The visibility of a product variant." } } } @@ -110761,58 +117816,6 @@ "items": { "type": "string" } - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true } } } @@ -110823,165 +117826,9 @@ "format": "date-time", "description": "The date and time the product was published in ISO 8601 format.", "example": "2015-07-15T19:28:00+00:00" - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true } } } - }, - "default": { - "description": "An error generated by the Mailchimp API.", - "schema": { - "type": "object", - "title": "Problem Detail Document", - "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", - "required": [ - "type", - "title", - "status", - "detail", - "instance" - ], - "properties": { - "type": { - "type": "string", - "title": "Problem Type", - "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", - "example": "https://mailchimp.com/developer/marketing/docs/errors/" - }, - "title": { - "type": "string", - "title": "Error Title", - "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", - "example": "Resource Not Found" - }, - "status": { - "type": "integer", - "title": "HTTP Status Code", - "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", - "example": 404 - }, - "detail": { - "type": "string", - "title": "Error Message", - "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", - "example": "The requested resource could not be found." - }, - "instance": { - "type": "string", - "title": "Instance ID", - "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", - "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" - } - } - } - } - }, - "deprecated": false, - "tags": [ - "ecommerce" - ], - "x-custom-config": { - "methodNameSnake": "add_store_product", - "methodNameCamel": "addStoreProduct" - } - } - }, - "/ecommerce/stores/{store_id}/products/{product_id}": { - "get": { - "summary": "Get product info", - "description": "Get information about a specific product.", - "operationId": "getEcommerceStoresIdProductsId", - "parameters": [ - { - "name": "fields", - "x-title": "Fields", - "in": "query", - "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "exclude_fields", - "x-title": "Exclude Fields", - "in": "query", - "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", - "required": false, - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" - } - }, - { - "name": "store_id", - "x-title": "Store ID", - "description": "The store id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "product_id", - "x-title": "Product ID", - "description": "The id for the product of a store.", - "in": "path", - "required": true, - "type": "string" } ], "responses": { @@ -111367,14 +118214,14 @@ "ecommerce" ], "x-custom-config": { - "methodNameSnake": "get_store_product", - "methodNameCamel": "getStoreProduct" + "methodNameSnake": "update_store_product", + "methodNameCamel": "updateStoreProduct" } }, - "patch": { - "summary": "Update product", + "put": { + "summary": "Create or update product", "description": "Update a specific product.", - "operationId": "patchEcommerceStoresIdProductsId", + "operationId": "putEcommerceStoresIdProductsId", "parameters": [ { "name": "store_id", @@ -111401,7 +118248,15 @@ "type": "object", "title": "E-commerce Product", "description": "Information about a specific product.", + "required": [ + "id" + ], "properties": { + "id": { + "type": "string", + "title": "Product Foreign ID", + "description": "A unique identifier for the product." + }, "title": { "type": "string", "title": "Title", @@ -111449,7 +118304,16 @@ "type": "object", "title": "E-commerce Product Variant", "description": "Information about a specific product variant.", + "required": [ + "id", + "title" + ], "properties": { + "id": { + "type": "string", + "title": "Product Variant Foreign ID", + "description": "A unique identifier for the product variant." + }, "title": { "type": "string", "title": "Title", @@ -111502,6 +118366,10 @@ "type": "object", "title": "E-commerce Product Image", "description": "Information about a specific product image.", + "required": [ + "id", + "url" + ], "properties": { "id": { "type": "string", @@ -111528,7 +118396,7 @@ "type": "string", "title": "Foreign Publish Time", "format": "date-time", - "description": "The date and time the product was published in ISO 8601 format.", + "description": "The date and time the product was published.", "example": "2015-07-15T19:28:00+00:00" } } @@ -111918,8 +118786,8 @@ "ecommerce" ], "x-custom-config": { - "methodNameSnake": "update_store_product", - "methodNameCamel": "updateStoreProduct" + "methodNameSnake": "create_or_update_store_product", + "methodNameCamel": "createOrUpdateStoreProduct" } }, "delete": { @@ -117177,6 +124045,192 @@ } } }, + "resend_shortcut_eligibility": { + "type": "object", + "title": "Resend Shortcut Eligibility", + "description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`.", + "properties": { + "to_non_openers": { + "type": "object", + "title": "To Non-Openers", + "description": "Determines if the campaign qualifies to be resent to non-openers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_new_subscribers": { + "type": "object", + "title": "To New Subscribers", + "description": "Determines if the campaign qualifies to be resent to new subscribers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_clickers": { + "type": "object", + "title": "To Non-Clickers", + "description": "Determines if the campaign qualifies to be resent to non-clickers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + }, + "to_non_purchasers": { + "type": "object", + "title": "To Non-Purchasers", + "description": "Determines if the campaign qualifies to be resent to non-purchasers.", + "properties": { + "is_eligible": { + "type": "boolean", + "title": "Is Eligible", + "description": "Determines if the campaign qualifies to be resent to this segment.", + "readOnly": true + }, + "reason": { + "type": "string", + "title": "Reason", + "description": "The reason the campaign is not eligible to be resent to this segment.", + "readOnly": true + } + } + } + } + }, + "resend_shortcut_usage": { + "type": "object", + "title": "Resend Shortcut Usage", + "description": "Information about campaigns related through shortcuts.", + "properties": { + "shortcut_campaigns": { + "type": "array", + "title": "Shortcut Campaigns", + "description": "Campaigns that were created from Campaign Resend Shortcuts for this campaign", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "Unique ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time a resent campaign was sent.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "enum": [ + "save", + "paused", + "schedule", + "sending", + "sent", + "canceled", + "canceling", + "archived" + ], + "readOnly": true + } + } + } + }, + "original_campaign": { + "type": "object", + "title": "Original Campaign", + "description": "The original campaign that was resent.", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "ID for the resent campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title of the original campaign.", + "readOnly": true + }, + "shortcut_type": { + "type": "string", + "title": "Shortcut Type", + "description": "Which campaign resend shortcut was used.", + "enum": [ + "non_openers", + "new_subscribers", + "non_clickers", + "non_purchasers" + ], + "readOnly": true + } + } + } + } + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -117488,6 +124542,27 @@ "description": "Indicates whether a contact consents to 1:1 messaging.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, + "sms_subscription_status": { + "type": "string", + "title": "SMS Subscription Status", + "description": "The status of an SMS subscription.", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ] + }, + "sms_subscription_last_updated": { + "type": "string", + "title": "SMS Subscription Last Update", + "description": "The datetime when the SMS subscription was last updated" + }, "merge_fields": { "type": "object", "title": "Merge Fields", @@ -117897,6 +124972,27 @@ "description": "Indicates whether a contact consents to 1:1 messaging.", "readOnly": true }, + "sms_phone_number": { + "type": "string", + "title": "SMS Phone Number", + "description": "A US phone number for SMS contact." + }, + "sms_subscription_status": { + "type": "string", + "title": "SMS Subscription Status", + "description": "The status of an SMS subscription.", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ] + }, + "sms_subscription_last_updated": { + "type": "string", + "title": "SMS Subscription Last Update", + "description": "The datetime when the SMS subscription was last updated" + }, "merge_fields": { "type": "object", "title": "Merge Fields", @@ -118513,22 +125609,26 @@ "properties": { "id": { "type": "string", - "description": "Unique ID of an Outreach" + "title": "ID", + "description": "Unique ID of an Outreach." }, "web_id": { "type": "integer", - "description": "Web ID" + "title": "Web ID", + "description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`." }, "name": { "type": "string", - "description": "Title or name of an Outreach" + "title": "Name", + "description": "Title or name of an Outreach." }, "type": { "type": "string", - "title": "Outreach type", - "description": "Supported Campaign, Ad, Page type", + "title": "Outreach Type", + "description": "The type of outreach this object is.", "enum": [ "regular", + "email-touchpoint", "plaintext", "rss", "reconfirm", @@ -118541,17 +125641,21 @@ "transactional", "page", "website", - "survey" + "social_post", + "survey", + "customer_journey", + "sms" ] }, "status": { "type": "string", - "title": "Outreach status", - "description": "Campaign, Ad, or Page status", + "title": "Outreach Status", + "description": "The status of this outreach.", "enum": [ "save", "paused", "schedule", + "scheduled", "sending", "sent", "canceled", @@ -118570,43 +125674,67 @@ }, "show_report": { "type": "boolean", - "description": "Outreach report availability" + "title": "Show Report", + "description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." }, "create_time": { "type": "string", - "format": "date-time" + "title": "Create Time", + "format": "date-time", + "description": "The date and time the outreach was created in ISO 8601 format." }, "start_time": { "type": "string", - "format": "date-time" + "title": "Start Time", + "format": "date-time", + "description": "The date and time the outreach was started in ISO 8601 format." }, "updated_at": { "type": "string", - "format": "date-time" + "title": "Updated At", + "format": "date-time", + "description": "The date and time the outreach was last updated in ISO 8601 format." }, "canceled_at": { "type": "string", - "format": "date-time" + "title": "Canceled At", + "format": "date-time", + "description": "The date and time the outreach was canceled in ISO 8601 format." }, "published_time": { "type": "string", - "format": "date-time" + "title": "Publish Time", + "format": "date-time", + "description": "The date and time the outreach was (or will be) published in ISO 8601 format." }, "has_segment": { - "type": "boolean" + "type": "boolean", + "title": "Has Segment", + "description": "If this outreach targets a segment of your audience." }, "report_summary": { "type": "object", + "title": "Report Summary", + "description": "High level reporting stats for an outreach.", "properties": { "opens": { "type": "integer" }, + "proxy_excluded_opens": { + "type": "integer" + }, "unique_opens": { "type": "integer" }, + "proxy_excluded_unique_opens": { + "type": "integer" + }, "open_rate": { "type": "number" }, + "proxy_excluded_open_rate": { + "type": "number" + }, "clicks": { "type": "integer" }, @@ -118658,8 +125786,8 @@ }, "recipients": { "type": "object", - "title": "List", - "description": "List settings for the outreach", + "title": "Recipients", + "description": "High level audience information for who the outreach targets.", "properties": { "list_id": { "type": "string", @@ -120596,7 +127724,8 @@ }, "thumbnail": { "type": "string", - "description": "The URL of the thumbnail for this outreach" + "title": "Thumbnail", + "description": "The URL of the thumbnail for this outreach." } } }, @@ -120604,21 +127733,29 @@ "type": "object", "properties": { "email_source_name": { - "type": "string" + "type": "string", + "title": "Ad: Email Source Name" }, "paused_at": { "type": "string", - "format": "date-time" + "title": "Ad: Paused At", + "format": "date-time", + "description": "The date and time the ad was paused in ISO 8601 format." }, "end_time": { "type": "string", - "format": "date-time" + "title": "Ad: End Time", + "format": "date-time", + "description": "The date and time the ad was ended in ISO 8601 format." }, "needs_attention": { - "type": "boolean" + "type": "boolean", + "title": "Ad: Needs Attention", + "description": "If the ad has a problem and needs attention." }, "was_canceled_by_facebook": { - "type": "boolean" + "type": "boolean", + "title": "Ad: Was Canceled By Facebook" } } }, @@ -121112,22 +128249,26 @@ "properties": { "id": { "type": "string", - "description": "Unique ID of an Outreach" + "title": "ID", + "description": "Unique ID of an Outreach." }, "web_id": { "type": "integer", - "description": "Web ID" + "title": "Web ID", + "description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`." }, "name": { "type": "string", - "description": "Title or name of an Outreach" + "title": "Name", + "description": "Title or name of an Outreach." }, "type": { "type": "string", - "title": "Outreach type", - "description": "Supported Campaign, Ad, Page type", + "title": "Outreach Type", + "description": "The type of outreach this object is.", "enum": [ "regular", + "email-touchpoint", "plaintext", "rss", "reconfirm", @@ -121140,17 +128281,21 @@ "transactional", "page", "website", - "survey" + "social_post", + "survey", + "customer_journey", + "sms" ] }, "status": { "type": "string", - "title": "Outreach status", - "description": "Campaign, Ad, or Page status", + "title": "Outreach Status", + "description": "The status of this outreach.", "enum": [ "save", "paused", "schedule", + "scheduled", "sending", "sent", "canceled", @@ -121169,43 +128314,67 @@ }, "show_report": { "type": "boolean", - "description": "Outreach report availability" + "title": "Show Report", + "description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." }, "create_time": { "type": "string", - "format": "date-time" + "title": "Create Time", + "format": "date-time", + "description": "The date and time the outreach was created in ISO 8601 format." }, "start_time": { "type": "string", - "format": "date-time" + "title": "Start Time", + "format": "date-time", + "description": "The date and time the outreach was started in ISO 8601 format." }, "updated_at": { "type": "string", - "format": "date-time" + "title": "Updated At", + "format": "date-time", + "description": "The date and time the outreach was last updated in ISO 8601 format." }, "canceled_at": { "type": "string", - "format": "date-time" + "title": "Canceled At", + "format": "date-time", + "description": "The date and time the outreach was canceled in ISO 8601 format." }, "published_time": { "type": "string", - "format": "date-time" + "title": "Publish Time", + "format": "date-time", + "description": "The date and time the outreach was (or will be) published in ISO 8601 format." }, "has_segment": { - "type": "boolean" + "type": "boolean", + "title": "Has Segment", + "description": "If this outreach targets a segment of your audience." }, "report_summary": { "type": "object", + "title": "Report Summary", + "description": "High level reporting stats for an outreach.", "properties": { "opens": { "type": "integer" }, + "proxy_excluded_opens": { + "type": "integer" + }, "unique_opens": { "type": "integer" }, + "proxy_excluded_unique_opens": { + "type": "integer" + }, "open_rate": { "type": "number" }, + "proxy_excluded_open_rate": { + "type": "number" + }, "clicks": { "type": "integer" }, @@ -121257,8 +128426,8 @@ }, "recipients": { "type": "object", - "title": "List", - "description": "List settings for the outreach", + "title": "Recipients", + "description": "High level audience information for who the outreach targets.", "properties": { "list_id": { "type": "string", @@ -123195,7 +130364,8 @@ }, "thumbnail": { "type": "string", - "description": "The URL of the thumbnail for this outreach" + "title": "Thumbnail", + "description": "The URL of the thumbnail for this outreach." } } }, @@ -123203,21 +130373,29 @@ "type": "object", "properties": { "email_source_name": { - "type": "string" + "type": "string", + "title": "Ad: Email Source Name" }, "paused_at": { "type": "string", - "format": "date-time" + "title": "Ad: Paused At", + "format": "date-time", + "description": "The date and time the ad was paused in ISO 8601 format." }, "end_time": { "type": "string", - "format": "date-time" + "title": "Ad: End Time", + "format": "date-time", + "description": "The date and time the ad was ended in ISO 8601 format." }, "needs_attention": { - "type": "boolean" + "type": "boolean", + "title": "Ad: Needs Attention", + "description": "If the ad has a problem and needs attention." }, "was_canceled_by_facebook": { - "type": "boolean" + "type": "boolean", + "title": "Ad: Was Canceled By Facebook" } } }, @@ -123692,22 +130870,26 @@ "properties": { "id": { "type": "string", - "description": "Unique ID of an Outreach" + "title": "ID", + "description": "Unique ID of an Outreach." }, "web_id": { "type": "integer", - "description": "Web ID" + "title": "Web ID", + "description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`." }, "name": { "type": "string", - "description": "Title or name of an Outreach" + "title": "Name", + "description": "Title or name of an Outreach." }, "type": { "type": "string", - "title": "Outreach type", - "description": "Supported Campaign, Ad, Page type", + "title": "Outreach Type", + "description": "The type of outreach this object is.", "enum": [ "regular", + "email-touchpoint", "plaintext", "rss", "reconfirm", @@ -123720,17 +130902,21 @@ "transactional", "page", "website", - "survey" + "social_post", + "survey", + "customer_journey", + "sms" ] }, "status": { "type": "string", - "title": "Outreach status", - "description": "Campaign, Ad, or Page status", + "title": "Outreach Status", + "description": "The status of this outreach.", "enum": [ "save", "paused", "schedule", + "scheduled", "sending", "sent", "canceled", @@ -123749,43 +130935,67 @@ }, "show_report": { "type": "boolean", - "description": "Outreach report availability" + "title": "Show Report", + "description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." }, "create_time": { "type": "string", - "format": "date-time" + "title": "Create Time", + "format": "date-time", + "description": "The date and time the outreach was created in ISO 8601 format." }, "start_time": { "type": "string", - "format": "date-time" + "title": "Start Time", + "format": "date-time", + "description": "The date and time the outreach was started in ISO 8601 format." }, "updated_at": { "type": "string", - "format": "date-time" + "title": "Updated At", + "format": "date-time", + "description": "The date and time the outreach was last updated in ISO 8601 format." }, "canceled_at": { "type": "string", - "format": "date-time" + "title": "Canceled At", + "format": "date-time", + "description": "The date and time the outreach was canceled in ISO 8601 format." }, "published_time": { "type": "string", - "format": "date-time" + "title": "Publish Time", + "format": "date-time", + "description": "The date and time the outreach was (or will be) published in ISO 8601 format." }, "has_segment": { - "type": "boolean" + "type": "boolean", + "title": "Has Segment", + "description": "If this outreach targets a segment of your audience." }, "report_summary": { "type": "object", + "title": "Report Summary", + "description": "High level reporting stats for an outreach.", "properties": { "opens": { "type": "integer" }, + "proxy_excluded_opens": { + "type": "integer" + }, "unique_opens": { "type": "integer" }, + "proxy_excluded_unique_opens": { + "type": "integer" + }, "open_rate": { "type": "number" }, + "proxy_excluded_open_rate": { + "type": "number" + }, "clicks": { "type": "integer" }, @@ -123837,8 +131047,8 @@ }, "recipients": { "type": "object", - "title": "List", - "description": "List settings for the outreach", + "title": "Recipients", + "description": "High level audience information for who the outreach targets.", "properties": { "list_id": { "type": "string", @@ -125775,7 +132985,8 @@ }, "thumbnail": { "type": "string", - "description": "The URL of the thumbnail for this outreach" + "title": "Thumbnail", + "description": "The URL of the thumbnail for this outreach." } } }, @@ -125783,21 +132994,29 @@ "type": "object", "properties": { "email_source_name": { - "type": "string" + "type": "string", + "title": "Ad: Email Source Name" }, "paused_at": { "type": "string", - "format": "date-time" + "title": "Ad: Paused At", + "format": "date-time", + "description": "The date and time the ad was paused in ISO 8601 format." }, "end_time": { "type": "string", - "format": "date-time" + "title": "Ad: End Time", + "format": "date-time", + "description": "The date and time the ad was ended in ISO 8601 format." }, "needs_attention": { - "type": "boolean" + "type": "boolean", + "title": "Ad: Needs Attention", + "description": "If the ad has a problem and needs attention." }, "was_canceled_by_facebook": { - "type": "boolean" + "type": "boolean", + "title": "Ad: Was Canceled By Facebook" } } }, @@ -126336,22 +133555,26 @@ "properties": { "id": { "type": "string", - "description": "Unique ID of an Outreach" + "title": "ID", + "description": "Unique ID of an Outreach." }, "web_id": { "type": "integer", - "description": "Web ID" + "title": "Web ID", + "description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`." }, "name": { "type": "string", - "description": "Title or name of an Outreach" + "title": "Name", + "description": "Title or name of an Outreach." }, "type": { "type": "string", - "title": "Outreach type", - "description": "Supported Campaign, Ad, Page type", + "title": "Outreach Type", + "description": "The type of outreach this object is.", "enum": [ "regular", + "email-touchpoint", "plaintext", "rss", "reconfirm", @@ -126364,17 +133587,21 @@ "transactional", "page", "website", - "survey" + "social_post", + "survey", + "customer_journey", + "sms" ] }, "status": { "type": "string", - "title": "Outreach status", - "description": "Campaign, Ad, or Page status", + "title": "Outreach Status", + "description": "The status of this outreach.", "enum": [ "save", "paused", "schedule", + "scheduled", "sending", "sent", "canceled", @@ -126393,43 +133620,67 @@ }, "show_report": { "type": "boolean", - "description": "Outreach report availability" + "title": "Show Report", + "description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." }, "create_time": { "type": "string", - "format": "date-time" + "title": "Create Time", + "format": "date-time", + "description": "The date and time the outreach was created in ISO 8601 format." }, "start_time": { "type": "string", - "format": "date-time" + "title": "Start Time", + "format": "date-time", + "description": "The date and time the outreach was started in ISO 8601 format." }, "updated_at": { "type": "string", - "format": "date-time" + "title": "Updated At", + "format": "date-time", + "description": "The date and time the outreach was last updated in ISO 8601 format." }, "canceled_at": { "type": "string", - "format": "date-time" + "title": "Canceled At", + "format": "date-time", + "description": "The date and time the outreach was canceled in ISO 8601 format." }, "published_time": { "type": "string", - "format": "date-time" + "title": "Publish Time", + "format": "date-time", + "description": "The date and time the outreach was (or will be) published in ISO 8601 format." }, "has_segment": { - "type": "boolean" + "type": "boolean", + "title": "Has Segment", + "description": "If this outreach targets a segment of your audience." }, "report_summary": { "type": "object", + "title": "Report Summary", + "description": "High level reporting stats for an outreach.", "properties": { "opens": { "type": "integer" }, + "proxy_excluded_opens": { + "type": "integer" + }, "unique_opens": { "type": "integer" }, + "proxy_excluded_unique_opens": { + "type": "integer" + }, "open_rate": { "type": "number" }, + "proxy_excluded_open_rate": { + "type": "number" + }, "clicks": { "type": "integer" }, @@ -126481,8 +133732,8 @@ }, "recipients": { "type": "object", - "title": "List", - "description": "List settings for the outreach", + "title": "Recipients", + "description": "High level audience information for who the outreach targets.", "properties": { "list_id": { "type": "string", @@ -128419,7 +135670,8 @@ }, "thumbnail": { "type": "string", - "description": "The URL of the thumbnail for this outreach" + "title": "Thumbnail", + "description": "The URL of the thumbnail for this outreach." } } }, @@ -128427,21 +135679,29 @@ "type": "object", "properties": { "email_source_name": { - "type": "string" + "type": "string", + "title": "Ad: Email Source Name" }, "paused_at": { "type": "string", - "format": "date-time" + "title": "Ad: Paused At", + "format": "date-time", + "description": "The date and time the ad was paused in ISO 8601 format." }, "end_time": { "type": "string", - "format": "date-time" + "title": "Ad: End Time", + "format": "date-time", + "description": "The date and time the ad was ended in ISO 8601 format." }, "needs_attention": { - "type": "boolean" + "type": "boolean", + "title": "Ad: Needs Attention", + "description": "If the ad has a problem and needs attention." }, "was_canceled_by_facebook": { - "type": "boolean" + "type": "boolean", + "title": "Ad: Was Canceled By Facebook" } } }, @@ -130357,7 +137617,7 @@ } } }, - "/reporting/surveys/{outreach_id}": { + "/reporting/surveys/{survey_id}": { "get": { "summary": "Get survey report", "description": "Get report for a survey.", @@ -130389,11 +137649,11 @@ }, { "in": "path", - "name": "outreach_id", - "x-title": "Outreach ID", + "name": "survey_id", + "x-title": "Survey ID", "type": "string", "required": true, - "description": "The outreach id." + "description": "The ID of the survey." } ], "responses": { @@ -130545,7 +137805,7 @@ } } }, - "/reporting/surveys/{outreach_id}/questions": { + "/reporting/surveys/{survey_id}/questions": { "get": { "summary": "List survey question reports", "description": "Get reports for survey questions.", @@ -130577,11 +137837,11 @@ }, { "in": "path", - "name": "outreach_id", - "x-title": "Outreach ID", + "name": "survey_id", + "x-title": "Survey ID", "type": "string", "required": true, - "description": "The outreach id." + "description": "The ID of the survey." } ], "responses": { @@ -130901,7 +138161,7 @@ } } }, - "/reporting/surveys/{outreach_id}/questions/{question_id}": { + "/reporting/surveys/{survey_id}/questions/{question_id}": { "get": { "summary": "Get survey question report", "description": "Get report for a survey question.", @@ -130933,11 +138193,11 @@ }, { "in": "path", - "name": "outreach_id", - "x-title": "Outreach ID", + "name": "survey_id", + "x-title": "Survey ID", "type": "string", "required": true, - "description": "The outreach id." + "description": "The ID of the survey." }, { "in": "path", @@ -131197,7 +138457,7 @@ } } }, - "/reporting/surveys/{outreach_id}/questions/{question_id}/answers": { + "/reporting/surveys/{survey_id}/questions/{question_id}/answers": { "get": { "summary": "List answers for question", "description": "Get answers for a survey question.", @@ -131229,11 +138489,11 @@ }, { "in": "path", - "name": "outreach_id", - "x-title": "Outreach ID", + "name": "survey_id", + "x-title": "Survey ID", "type": "string", "required": true, - "description": "The outreach id." + "description": "The ID of the survey." }, { "in": "path", @@ -131334,6 +138594,12 @@ "description": "The contact's email address.", "readOnly": true }, + "phone": { + "type": "string", + "title": "Contact SMS Phone", + "description": "The contact's sms phone number.", + "readOnly": true + }, "full_name": { "type": "string", "title": "Full Name", @@ -131481,7 +138747,7 @@ } } }, - "/reporting/surveys/{outreach_id}/responses": { + "/reporting/surveys/{survey_id}/responses": { "get": { "summary": "List survey responses", "description": "Get responses to a survey.", @@ -131513,11 +138779,11 @@ }, { "in": "path", - "name": "outreach_id", - "x-title": "Outreach ID", + "name": "survey_id", + "x-title": "Survey ID", "type": "string", "required": true, - "description": "The outreach id." + "description": "The ID of the survey." }, { "name": "answered_question", @@ -131614,6 +138880,12 @@ "description": "The contact's email address.", "readOnly": true }, + "phone": { + "type": "string", + "title": "Contact SMS Phone", + "description": "The contact's sms phone number.", + "readOnly": true + }, "full_name": { "type": "string", "title": "Full Name", @@ -131761,7 +139033,7 @@ } } }, - "/reporting/surveys/{outreach_id}/responses/{response_id}": { + "/reporting/surveys/{survey_id}/responses/{response_id}": { "get": { "summary": "Get survey response", "description": "Get a single survey response.", @@ -131769,11 +139041,11 @@ "parameters": [ { "in": "path", - "name": "outreach_id", - "x-title": "Outreach ID", + "name": "survey_id", + "x-title": "Survey ID", "type": "string", "required": true, - "description": "The outreach id." + "description": "The ID of the survey." }, { "in": "path", @@ -131842,6 +139114,12 @@ "description": "The contact's email address.", "readOnly": true }, + "phone": { + "type": "string", + "title": "Contact SMS Phone", + "description": "The contact's sms phone number.", + "readOnly": true + }, "full_name": { "type": "string", "title": "Full Name", @@ -132020,6 +139298,27 @@ "title": "Verification Challenge Sent", "description": "The date/time that the two-factor challenge was sent to the verification email.", "readOnly": true + }, + "status": { + "type": "string", + "title": "Domain Status", + "description": "The Domain's current status.", + "readOnly": true, + "enum": [ + "VERIFICATION_IN_PROGRESS", + "VERIFIED", + "EXPIRED", + "ERROR", + "AUTHENTICATION_IN_PROGRESS", + "AUTHENTICATION_ERROR", + "AUTHENTICATED" + ] + }, + "is_free_email_provider": { + "type": "boolean", + "title": "Is Public Domain", + "description": "Returns whether the domain used is a public / free email provider. See [Limitations of Free Email Addresses](https://mailchimp.com/help/limitations-of-free-email-addresses/) for more details.", + "readOnly": true } } } @@ -132231,6 +139530,27 @@ "title": "Verification Challenge Sent", "description": "The date/time that the two-factor challenge was sent to the verification email.", "readOnly": true + }, + "status": { + "type": "string", + "title": "Domain Status", + "description": "The Domain's current status.", + "readOnly": true, + "enum": [ + "VERIFICATION_IN_PROGRESS", + "VERIFIED", + "EXPIRED", + "ERROR", + "AUTHENTICATION_IN_PROGRESS", + "AUTHENTICATION_ERROR", + "AUTHENTICATED" + ] + }, + "is_free_email_provider": { + "type": "boolean", + "title": "Is Public Domain", + "description": "Returns whether the domain used is a public / free email provider. See [Limitations of Free Email Addresses](https://mailchimp.com/help/limitations-of-free-email-addresses/) for more details.", + "readOnly": true } } } @@ -132346,6 +139666,27 @@ "title": "Verification Challenge Sent", "description": "The date/time that the two-factor challenge was sent to the verification email.", "readOnly": true + }, + "status": { + "type": "string", + "title": "Domain Status", + "description": "The Domain's current status.", + "readOnly": true, + "enum": [ + "VERIFICATION_IN_PROGRESS", + "VERIFIED", + "EXPIRED", + "ERROR", + "AUTHENTICATION_IN_PROGRESS", + "AUTHENTICATION_ERROR", + "AUTHENTICATED" + ] + }, + "is_free_email_provider": { + "type": "boolean", + "title": "Is Public Domain", + "description": "Returns whether the domain used is a public / free email provider. See [Limitations of Free Email Addresses](https://mailchimp.com/help/limitations-of-free-email-addresses/) for more details.", + "readOnly": true } } } @@ -132481,6 +139822,27 @@ "title": "Verification Challenge Sent", "description": "The date/time that the two-factor challenge was sent to the verification email.", "readOnly": true + }, + "status": { + "type": "string", + "title": "Domain Status", + "description": "The Domain's current status.", + "readOnly": true, + "enum": [ + "VERIFICATION_IN_PROGRESS", + "VERIFIED", + "EXPIRED", + "ERROR", + "AUTHENTICATION_IN_PROGRESS", + "AUTHENTICATION_ERROR", + "AUTHENTICATED" + ] + }, + "is_free_email_provider": { + "type": "boolean", + "title": "Is Public Domain", + "description": "Returns whether the domain used is a public / free email provider. See [Limitations of Free Email Addresses](https://mailchimp.com/help/limitations-of-free-email-addresses/) for more details.", + "readOnly": true } } } @@ -132549,4 +139911,4 @@ "description": "Learn more with the full Mailchimp API documentation.", "url": "https://mailchimp.com/developer/marketing/" } -} +} \ No newline at end of file