Loading...
Trace | Cenit Admin
+ 1 - 38 update
2018-11-26 19:43:10 UTC
No message
  • 68 lines unchanged {
    • "$schema": "http://json-schema.org/draft-04/schema#",
    • "type": "object",
    • "title": "Campaign",
    • "description": "A summary of an individual campaign's settings and content.",
    • "properties": {
    • "campaign_id": {
    • "type": "string",
    • "title": "Campaign ID",
    • "description": "A string that uniquely identifies this campaign."
    • },
    • "type": {
    • "type": "string",
    • "title": "Campaign Type",
    • "description": "The type of campaign (regular, plain-text, ab_split, rss, or automation).",
    • "enum": [
    • "regular",
    • "plain-text",
    • "absplit",
    • "rss"
    • ],
    • "readonly": true
    • },
    • "create_time": {
    • "type": "string",
    • "format": "date-time",
    • "title": "Create Time",
    • "description": "The date and time the campaign was created.",
    • "readonly": true
    • },
    • "archive_url": {
    • "type": "string",
    • "title": "Archive URL",
    • "description": "The link to the campaign's archive version.",
    • "readonly": true
    • },
    • "status": {
    • "type": "string",
    • "title": "Campaign Status",
    • "description": "The current status of the campaign ('save', 'paused', 'schedule', 'sending', 'sent', 'canceled').",
    • "enum": [
    • "save",
    • "paused",
    • "schedule",
    • "sending",
    • "sent",
    • "canceled"
    • ],
    • "readonly": true
    • },
    • "emails_sent": {
    • "type": "integer",
    • "title": "Emails Sent",
    • "description": "The total number of emails sent for this campaign.",
    • "readonly": true
    • },
    • "send_time": {
    • "type": "string",
    • "format": "date-time",
    • "title": "Send Time",
    • "description": "The time and date a campaign was sent.",
    • "readonly": true
    • },
    • "content_type": {
    • "type": "string",
    • "title": "Content Type",
    • "description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').",
    • "readonly": true
  • "recipients": {
  • },
  • "type": "object",
  • "title": "List",
  • "description": "List settings for the campaign.",
  • "properties": {
  • "list_id": {
  • "type": "string",
  • "title": "List ID",
  • "description": "The id of the list."
  • },
  • "segment_opts": {
  • "type": "object",
  • "title": "Segment",
  • "properties": {
  • "saved_segment_id": {
  • "type": "integer",
  • "title": "Saved Segment ID",
  • "description": "The id for an existing saved segment."
  • },
  • "match": {
  • "type": "string",
  • "title": "Match Type",
  • "description": "Segment match type ('any' or 'all').",
  • "enum": [
  • "any",
  • "all"
  • ]
  • },
  • "conditions": {
  • "type": "array",
  • "title": "Segment Conditions",
  • "description": "An array of segment conditions.",
  • "items": {
  • "type": "object"
  • }
  • }
  • }
  • }
  • }
  • "$ref": "Recipient"
  • },
  • "settings": {
  • 358 lines unchanged "$ref": "CampaignSettings"
    • },
    • "tracking": {
    • "type": "object",
    • "title": "Campiagn Tracking Options",
    • "description": "The tracking options for a campaign.",
    • "properties": {
    • "opens": {
    • "type": "boolean",
    • "title": "Opens",
    • "description": "Whether to track opens. Defaults to 'true.'"
    • },
    • "html_clicks": {
    • "type": "boolean",
    • "title": "HTML Click Tracking",
    • "description": "Whether to track clicks in the HTML version of the campaign. Defaults to 'true.'"
    • },
    • "text_clicks": {
    • "type": "boolean",
    • "title": "Plain-Text Click Tracking",
    • "description": "Whether to track clicks in the plain-text version of the campaign. Defaults to true"
    • },
    • "goal_tracking": {
    • "type": "boolean",
    • "title": "MailChimp Goal Tracking",
    • "description": "Whether to enable Goal Tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH"
    • },
    • "ecomm360": {
    • "type": "boolean",
    • "title": "Ecommerce360 Tracking",
    • "description": "Whether to enable Ecommerce360 Tracking."
    • },
    • "google_analytics": {
    • "type": "string",
    • "title": "Google Analytics Tracking",
    • "description": "The custom slug for Google Analytics tracking (max of 50 bytes)."
    • },
    • "clicktale": {
    • "type": "string",
    • "title": "ClickTale Analytics Tracking",
    • "description": "The custom slug for ClickTale Analytics tracking (max of 50 bytes)."
    • },
    • "salesforce": {
    • "type": "object",
    • "title": "Salesforce CRM Tracking",
    • "description": "Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration.",
    • "properties": {
    • "campaign": {
    • "type": "boolean",
    • "title": "Salesforce Campaign",
    • "description": "Create a campaign within a connected Salesforce account."
    • },
    • "notes": {
    • "type": "boolean",
    • "title": "Salesforce Note",
    • "description": "Update Contact notes for a campaign based on subscriber email addresses."
    • }
    • }
    • },
    • "highrise": {
    • "type": "object",
    • "title": "Highrise CRM Tracking",
    • "description": "Highrise tracking options for a campaign. Must be using MailChimp's built-in Highrise integration.",
    • "properties": {
    • "campaign": {
    • "type": "boolean",
    • "title": "Highrise Campaign",
    • "description": "Create a campaign within a connected Highrise account."
    • },
    • "notes": {
    • "type": "boolean",
    • "title": "Highrise Note",
    • "description": "Update Contact notes for a campaign based on subscriber email addresses."
    • }
    • }
    • },
    • "capsule": {
    • "type": "object",
    • "title": "Capsule CRM Tracking",
    • "description": "Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration.",
    • "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-specific options for a campaign.",
    • "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-to-Email campaign ('daily', 'weekly', 'monthly').",
    • "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 (local time)",
    • "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 timezone."
    • },
    • "daily_send": {
    • "type": "object",
    • "title": "Daily Sending Days",
    • "description": "The days of the week to send a daily RSS-to-Email 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-to-Email 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-to-Email campaign. Acceptable days are 1 - 32, 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. Ex. RSS-to-Email 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
    • }
    • }
    • },
    • "ab_split_opts": {
    • "type": "object",
    • "title": "AB Split Options",
    • "description": "AB Split-specific options for a campaign.",
    • "properties": {
    • "split_test": {
    • "type": "string",
    • "title": "Split Test",
    • "description": "The type of AB split to run ('subject', 'from_name', or 'schedule').",
    • "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. Ex. A 10% split would result in two groups of 10% of the subscribers plus a winner sending to the remaining 80%."
    • },
    • "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 campaings split on 'Subject Line', the subject line for Group A."
    • },
    • "subject_b": {
    • "type": "string",
    • "title": "Subject Line Group B",
    • "description": "For campaings 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 as rendered by social networks like Facebook and Twitter.",
    • "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": {
    • "$ref": "reports.json"
    • },
    • "delivery_status": {
    • "$ref": "delivery.json"
    • },
    • "_links": {
    • "type": "array",
    • "items": {
    • "$ref": "ResourceLink.json"
    • }
    • }
    • },
    • "links": [
    • {
    • "rel": "parent",
    • "href": "https://us9.api.mailchimp.com/3.0/campaigns",
    • "method": "GET",
    • "targetSchema": "https://us9.api.mailchimp.com/schema/3.0/Campaigns/Collection.json"
    • },
    • {
    • "rel": "self",
    • "href": "https://us9.api.mailchimp.com/3.0/campaigns/{id}",
    • "method": "GET",
    • "targetSchema": "https://us9.api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
    • },
    • {
    • "rel": "delete",
    • "href": "https://us9.api.mailchimp.com/3.0/campaigns/{id}",
    • "method": "DELETE"
    • },
    • {
    • "rel": "cancel_send",
    • "href": "https://us9.api.mailchimp.com/3.0/campaigns/{id}/actions/cancel-send",
    • "method": "POST"
    • },
    • {
    • "rel": "feedback",
    • "href": "https://us9.api.mailchimp.com/3.0/campaigns/{id}/feedback",
    • "method": "GET",
    • "targetSchema": "https://us9.api.mailchimp.com/schema/3.0/Campaigns/Feedback/Collection.json"
    • }
    • ]
    • }