"""Request Body Schemas for API Tools

DO NOT EDIT THIS MODULE DIRECTLY.

THIS MODULE WAS AUTO-GENERATED AND CONTAINS OpenAPI REQUEST BODY SCHEMAS
FOR TOOLS WITH COMPLEX REQUEST BODIES. ANY CHANGES TO THIS MODULE WILL
BE OVERWRITTEN BY THE TRANSPILER.
"""
from typing import Any

REQUEST_BODY_SCHEMAS: dict[str, Any] = {
    "CREATEAUDIENCECONTACT": '{"type": "object", "description": "An instance of a contact.", "properties": {"language": {"type": "string", "title": "Language", "description": "The subscribers detected language.", "example": "EN"}, "email_channel": {"type": "object", "title": "Email Channel Details", "properties": {"email": {"type": "string", "title": "Email Address", "description": "Email address", "example": "example@freddiemail.com"}, "marketing_consent": {"type": "object", "title": "Marketing Consent Details", "description": "A contact\'s current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.", "properties": {"status": {"type": "string", "title": "Marketing Consent Status", "description": "Status of a contacts Marketing Consent", "enum": ["confirmed", "consented", "denied", "unknown"], "example": "confirmed"}}}}}, "sms_channel": {"type": "object", "title": "SMS Channel Details", "properties": {"sms_phone": {"type": "string", "title": "SMS Phone Number", "description": "SMS Phone Number", "example": "+16155550128"}, "marketing_consent": {"type": "object", "title": "Marketing Consent Details", "description": "A contact\'s current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.", "properties": {"status": {"type": "string", "title": "Marketing Consent Status", "description": "The current consent status captured for a contact\u2019s marketing communications.", "enum": ["confirmed", "consented", "unknown"], "example": "confirmed"}}}}}, "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."}}, "tags": {"type": "array", "title": "Tags", "description": "An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.", "items": {"type": "string", "title": "Tag Name"}, "example": ["new_tag", "another_tag"]}}}',  # noqa: E501
    "UPDATECONTACTINFORMATION": '{"type": "object", "description": "An instance of a contact.", "properties": {"language": {"type": "string", "title": "Language", "description": "The subscribers detected language.", "example": "EN"}, "email_channel": {"type": "object", "title": "Email Channel Details", "properties": {"email": {"type": "string", "title": "Email Address", "description": "Email address", "example": "example@freddiemail.com"}, "marketing_consent": {"description": "A contact\'s current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.", "type": "object", "properties": {"status": {"type": "string", "title": "Marketing Consent Status", "enum": ["consented", "denied", "confirmed", "unknown"]}, "source": {"type": "object", "title": "Source", "description": "The source from which the parent\'s entity was created from.", "properties": {"name": {"type": "string", "title": "Entity source name", "description": "The name of the entity\'s source"}}}}}}}, "sms_channel": {"type": "object", "title": "SMS Channel Details", "properties": {"sms_phone": {"type": "string", "title": "SMS Phone Number", "description": "SMS Phone Number", "example": "+16155550128"}, "marketing_consent": {"description": "A contact\'s current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.", "type": "object", "properties": {"status": {"type": "string", "title": "Marketing Consent Status", "enum": ["consented", "confirmed", "unknown"]}, "source": {"type": "object", "title": "Source", "description": "The source from which the parent\'s entity was created from.", "properties": {"name": {"type": "string", "title": "Entity source name", "description": "The name of the entity\'s source"}}}}}}}, "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."}}, "tags": {"type": "array", "title": "Tags", "description": "An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.", "items": {"type": "string", "title": "Tag Name"}, "example": ["tag_to_add_1", "tag_to_add_2"]}}}',  # noqa: E501
    "UPDATEAUTOMATIONEMAILSETTINGS": '{"type": "object", "title": "Update information about a specific workflow email", "description": "Update information about an individual Automation workflow email.", "properties": {"settings": {"type": "object", "title": "Campaign Settings", "description": "Settings for the campaign including the email subject, from name, and from email address.", "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": "Automation Title", "description": "The title of the Automation."}, "from_name": {"type": "string", "title": "From Name", "description": "The \'from\' name for the Automation (not an email address)."}, "reply_to": {"type": "string", "title": "Reply To Address", "description": "The reply-to email address for the Automation."}}}, "delay": {"type": "object", "title": "Automation Delay", "description": "The delay settings for an automation email.", "required": ["action"], "properties": {"amount": {"type": "integer", "title": "Delay Amount", "description": "The delay amount for an automation email.", "example": 1}, "type": {"type": "string", "enum": ["now", "day", "hour", "week"], "title": "Delay Type", "description": "The type of delay for an automation email.", "example": "day"}, "direction": {"type": "string", "title": "Delay Direction", "description": "Whether the delay settings describe before or after the delay action of an automation email.", "enum": ["after"], "example": "after"}, "action": {"type": "string", "title": "Delay Action", "description": "The action that triggers the delay of an automation emails.", "enum": ["signup", "ecomm_abandoned_browse", "ecomm_abandoned_cart"], "example": "signup"}}}}}',  # noqa: E501
    "STARTBATCHPROCESSING": '{"type": "object", "required": ["operations"], "properties": {"operations": {"type": "array", "title": "Operations List", "description": "An array of objects that describes operations to perform.", "items": {"type": "object", "title": "Operations", "required": ["method", "path"], "properties": {"method": {"type": "string", "title": "HTTP Method", "description": "The HTTP method to use for the operation.", "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"], "example": "POST"}, "path": {"type": "string", "title": "Path", "description": "The relative path to use for the operation.", "example": "/lists"}, "params": {"type": "object", "title": "Query Parameters", "description": "Any request query parameters. Example parameters: {\"count\":10, \"offset\":0}", "example": "{\"count\":10,\"offset\":0}"}, "body": {"type": "string", "title": "Body", "description": "A string containing the JSON body to use with the request.", "example": "{\"title\":\"Test\"}"}, "operation_id": {"type": "string", "title": "Operation ID", "description": "An optional client-supplied id returned with the operation results.", "example": "my-id-123"}}}}}}',  # noqa: E501
    "CREATEMAILCHIMPCAMPAIGN": '{"type": "object", "title": "Campaign", "description": "A summary of an individual campaign\'s settings and content.", "required": ["type"], "properties": {"type": {"type": "string", "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"]}, "recipients": {"type": "object", "title": "List", "description": "List settings for the campaign.", "required": ["list_id"], "properties": {"list_id": {"type": "string", "title": "List ID", "description": "The unique list id."}, "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."}, "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. Note: while this field is not required for campaign creation, it is required for sending."}, "use_conversation": {"type": "boolean", "title": "Conversation", "description": "Use Mailchimp Conversation feature to manage out-of-office 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`."}, "template_id": {"type": "integer", "title": "Template ID", "description": "The id of the template to use."}}}, "variate_settings": {"type": "object", "title": "A/B Test Options", "description": "The settings specific to A/B test campaigns.", "required": ["winner_criteria"], "properties": {"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"}}}}, "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, specific to an RSS 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-defaults/)."}, "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."}}}, "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."}}}, "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."}}}, "content_type": {"type": "string", "title": "Content Type", "description": "How the campaign\'s content is put together. The old drag and drop editor uses \'template\' while the new editor uses \'multichannel\'. Defaults to template.", "example": "template", "enum": ["template", "multichannel"]}}}',  # noqa: E501
    "UPDATECAMPAIGNSETTINGS": '{"type": "object", "title": "Campaign", "description": "A summary of an individual campaign\'s settings and content.", "required": ["settings"], "properties": {"recipients": {"type": "object", "title": "List", "description": "List settings for the campaign.", "required": ["list_id"], "properties": {"list_id": {"type": "string", "title": "List ID", "description": "The unique list id."}, "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.", "required": ["subject_line", "from_name", "reply_to"], "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 out-of-office 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`."}, "template_id": {"type": "integer", "title": "Template ID", "description": "The id of the template to use."}}}, "variate_settings": {"type": "object", "title": "A/B Test Options", "description": "The settings specific to A/B test campaigns.", "required": ["winner_criteria"], "properties": {"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"}}}}, "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-defaults/)."}, "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."}}}, "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."}}}, "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."}}}}}',  # noqa: E501
    "SETCAMPAIGNCONTENT": '{"type": "object", "title": "Campaign Content", "description": "The HTML and plain-text content for a campaign", "properties": {"plain_text": {"type": "string", "title": "Plain Text", "description": "The plain-text portion of the campaign. If left unspecified, we\'ll generate this automatically."}, "html": {"type": "string", "title": "Campaign HTML", "description": "The raw HTML for the campaign."}, "url": {"type": "string", "title": "Campaign URL", "description": "When importing a campaign, the URL where the HTML lives."}, "template": {"type": "object", "title": "Template Content", "description": "Use this template to generate the HTML content of the campaign", "required": ["id"], "properties": {"id": {"type": "integer", "title": "Template ID", "description": "The id of the template to use."}, "sections": {"type": "object", "title": "Template Sections", "description": "Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template."}}}, "archive": {"type": "object", "title": "Upload Archive", "description": "Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/).", "required": ["archive_content"], "properties": {"archive_content": {"type": "string", "title": "Archive Content", "description": "The base64-encoded representation of the archive file."}, "archive_type": {"type": "string", "enum": ["zip", "tar.gz", "tar.bz2", "tar", "tgz", "tbz"], "title": "Archive Type", "description": "The type of encoded file. Defaults to zip."}}}, "variate_contents": {"type": "array", "title": "Variate Contents", "description": "Content options for [Multivariate Campaigns](https://mailchimp.com/help/about-multivariate-campaigns/). Each content option must provide HTML content and may optionally provide plain text. For campaigns not testing content, only one object should be provided.", "items": {"type": "object", "required": ["content_label"], "properties": {"content_label": {"type": "string", "title": "Content Label", "description": "The label used to identify the content option."}, "plain_text": {"type": "string", "title": "Plain Text", "description": "The plain-text portion of the campaign. If left unspecified, we\'ll generate this automatically."}, "html": {"type": "string", "title": "Campaign HTML", "description": "The raw HTML for the campaign."}, "url": {"type": "string", "title": "Campaign URL", "description": "When importing a campaign, the URL for the HTML."}, "template": {"type": "object", "title": "Template Content", "description": "Use this template to generate the HTML content for the campaign.", "required": ["id"], "properties": {"id": {"type": "integer", "title": "Template ID", "description": "The id of the template to use."}, "sections": {"type": "object", "title": "Template Sections", "description": "Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template."}}}, "archive": {"type": "object", "title": "Upload Archive", "description": "Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/).", "required": ["archive_content"], "properties": {"archive_content": {"type": "string", "title": "Archive Content", "description": "The base64-encoded representation of the archive file."}, "archive_type": {"type": "string", "enum": ["zip", "tar.gz", "tar.bz2", "tar", "tgz", "tbz"], "title": "Archive Type", "description": "The type of encoded file. Defaults to zip."}}}}}}}}',  # noqa: E501
    "CREATEMAILCHIMPLIST": '{"type": "object", "title": "Subscriber List", "description": "Information about a specific list.", "required": ["name", "permission_reminder", "email_type_option", "contact", "campaign_defaults"], "properties": {"name": {"type": "string", "title": "List Name", "description": "The name of the list."}, "contact": {"type": "object", "title": "List Contact", "description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.", "required": ["company", "address1", "city", "country"], "properties": {"company": {"type": "string", "title": "Company Name", "description": "The company name for the list."}, "address1": {"type": "string", "title": "Address", "description": "The street address for the list contact."}, "address2": {"type": "string", "title": "Address", "description": "The street address for the list contact."}, "city": {"type": "string", "title": "City", "description": "The city for the list contact."}, "state": {"type": "string", "title": "State", "description": "The state for the list contact."}, "zip": {"type": "string", "title": "Postal Code", "description": "The postal or zip code for the list contact."}, "country": {"type": "string", "title": "Country Code", "description": "A two-character ISO3166 country code. Defaults to US if invalid."}, "phone": {"type": "string", "title": "Phone Number", "description": "The phone number for the list contact."}}}, "permission_reminder": {"type": "string", "title": "Permission Reminder", "description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."}, "use_archive_bar": {"type": "boolean", "title": "Use Archive Bar", "description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default.", "default": false}, "campaign_defaults": {"type": "object", "title": "Campaign Defaults", "description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.", "required": ["from_name", "from_email", "subject", "language"], "properties": {"from_name": {"type": "string", "title": "Sender\'s Name", "description": "The default from name for campaigns sent to this list."}, "from_email": {"type": "string", "title": "Sender\'s Email Address", "description": "The default from email for campaigns sent to this list."}, "subject": {"type": "string", "title": "Subject", "description": "The default subject line for campaigns sent to this list."}, "language": {"type": "string", "title": "Language", "description": "The default language for this lists\'s forms."}}}, "notify_on_subscribe": {"type": "string", "title": "Notify on Subscribe", "description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to.", "default": false}, "notify_on_unsubscribe": {"type": "string", "title": "Notify on Unsubscribe", "description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to.", "default": false}, "email_type_option": {"type": "boolean", "title": "Email Type Option", "description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."}, "double_optin": {"type": "boolean", "title": "Double Opt In", "description": "Whether or not to require the subscriber to confirm subscription via email.", "default": false}, "marketing_permissions": {"type": "boolean", "title": "Marketing Permissions", "description": "Whether or not the list has marketing permissions (eg. GDPR) enabled.", "default": false}}}',  # noqa: E501
    "UPDATEMAILCHIMPLISTSETTINGS": '{"type": "object", "title": "Subscriber List", "description": "Information about a specific list.", "required": ["name", "permission_reminder", "email_type_option", "contact", "campaign_defaults"], "properties": {"name": {"type": "string", "title": "List Name", "description": "The name of the list."}, "contact": {"type": "object", "title": "List Contact", "description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.", "required": ["company", "address1", "city", "state", "zip", "country"], "properties": {"company": {"type": "string", "title": "Company Name", "description": "The company name for the list."}, "address1": {"type": "string", "title": "Address", "description": "The street address for the list contact."}, "address2": {"type": "string", "title": "Address", "description": "The street address for the list contact."}, "city": {"type": "string", "title": "City", "description": "The city for the list contact."}, "state": {"type": "string", "title": "State", "description": "The state for the list contact."}, "zip": {"type": "string", "title": "Postal Code", "description": "The postal or zip code for the list contact."}, "country": {"type": "string", "title": "Country Code", "description": "A two-character ISO3166 country code. Defaults to US if invalid."}, "phone": {"type": "string", "title": "Phone Number", "description": "The phone number for the list contact."}}}, "permission_reminder": {"type": "string", "title": "Permission Reminder", "description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."}, "use_archive_bar": {"type": "boolean", "title": "Use Archive Bar", "description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default.", "default": false}, "campaign_defaults": {"type": "object", "title": "Campaign Defaults", "description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.", "required": ["from_name", "from_email", "subject", "language"], "properties": {"from_name": {"type": "string", "title": "Sender\'s Name", "description": "The default from name for campaigns sent to this list."}, "from_email": {"type": "string", "title": "Sender\'s Email Address", "description": "The default from email for campaigns sent to this list."}, "subject": {"type": "string", "title": "Subject", "description": "The default subject line for campaigns sent to this list."}, "language": {"type": "string", "title": "Language", "description": "The default language for this lists\'s forms."}}}, "notify_on_subscribe": {"type": "string", "title": "Notify on Subscribe", "description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to.", "default": false}, "notify_on_unsubscribe": {"type": "string", "title": "Notify on Unsubscribe", "description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to.", "default": false}, "email_type_option": {"type": "boolean", "title": "Email Type Option", "description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."}, "double_optin": {"type": "boolean", "title": "Double Opt In", "description": "Whether or not to require the subscriber to confirm subscription via email.", "default": false}, "marketing_permissions": {"type": "boolean", "title": "Marketing Permissions", "description": "Whether or not the list has marketing permissions (eg. GDPR) enabled.", "default": false}}}',  # noqa: E501
    "MANAGEMAILCHIMPLISTMEMBERS": '{"type": "object", "title": "Members to Subscribe/Unsubscribe to/from a List in batch", "description": "Members to subscribe to or unsubscribe from a list.", "required": ["members"], "properties": {"members": {"type": "array", "title": "List Members", "description": "An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call.", "items": {"type": "object", "title": "Add List Members", "description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.", "properties": {"email_address": {"type": "string", "title": "Email Address", "description": "Email address for a subscriber."}, "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": "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."}}, "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."}, "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."}}}, "ip_signup": {"type": "string", "title": "Signup IP", "description": "IP address the subscriber signed up from."}, "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"}, "ip_opt": {"type": "string", "title": "Opt-in IP", "description": "The IP address the subscriber used to confirm their opt-in status."}, "timestamp_opt": {"type": "string", "title": "Opt-in Timestamp", "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.", "format": "date-time"}}}}, "sync_tags": {"type": "boolean", "title": "Sync Tags", "description": "Whether this batch operation will replace all existing tags with tags in request."}, "update_existing": {"type": "boolean", "title": "Update Existing Members", "description": "Whether this batch operation will change existing members\' subscription status."}}}',  # noqa: E501
    "ADDMEMBERTOMAILCHIMPLIST": '{"type": "object", "title": "Add List Members", "description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.", "required": ["email_address", "status"], "properties": {"email_address": {"type": "string", "title": "Email Address", "description": "Email address for a subscriber."}, "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": "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."}}, "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."}, "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."}}}, "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"}, "enabled": {"type": "boolean", "title": "Enabled", "description": "If the subscriber has opted-in to the marketing permission."}}}}, "ip_signup": {"type": "string", "title": "Signup IP", "description": "IP address the subscriber signed up from."}, "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"}, "ip_opt": {"type": "string", "title": "Opt-in IP", "description": "The IP address the subscriber used to confirm their opt-in status."}, "timestamp_opt": {"type": "string", "title": "Opt-in Timestamp", "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.", "format": "date-time"}, "tags": {"type": "array", "title": "Tags on a member", "description": "The tags that are associated with a member.", "items": {"type": "string", "description": "The name of the tag that will be associated with this member."}}}}',  # noqa: E501
    "ADDORUPDATELISTMEMBER": '{"type": "object", "title": "Add List Members", "description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.", "required": ["email_address", "status_if_new"], "properties": {"email_address": {"type": "string", "title": "Email Address", "description": "Email address for a subscriber. This value is required only if the email address is not already present on the list."}, "status_if_new": {"type": "string", "title": "New Member Status", "description": "Subscriber\'s status. This value is required only if the email address is not already present on the list.", "enum": ["subscribed", "unsubscribed", "cleaned", "pending", "transactional"]}, "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": "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."}}, "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."}, "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."}}}, "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"}, "enabled": {"type": "boolean", "title": "Enabled", "description": "If the subscriber has opted-in to the marketing permission."}}}}, "ip_signup": {"type": "string", "title": "Signup IP", "description": "IP address the subscriber signed up from."}, "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"}, "ip_opt": {"type": "string", "title": "Opt-in IP", "description": "The IP address the subscriber used to confirm their opt-in status."}, "timestamp_opt": {"type": "string", "title": "Opt-in Timestamp", "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.", "format": "date-time"}}}',  # noqa: E501
    "UPDATELISTMEMBERINFO": '{"type": "object", "title": "Add List Members", "description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.", "properties": {"email_address": {"type": "string", "title": "Email Address", "description": "Email address for a subscriber."}, "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"]}, "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."}}, "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."}, "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."}}}, "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"}, "enabled": {"type": "boolean", "title": "Enabled", "description": "If the subscriber has opted-in to the marketing permission."}}}}, "ip_signup": {"type": "string", "title": "Signup IP", "description": "IP address the subscriber signed up from."}, "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"}, "ip_opt": {"type": "string", "title": "Opt-in IP", "description": "The IP address the subscriber used to confirm their opt-in status."}, "timestamp_opt": {"type": "string", "title": "Opt-in Timestamp", "description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.", "format": "date-time"}}}',  # noqa: E501
    "UPDATELISTMEMBERTAGS": '{"type": "object", "title": "Member Tags", "description": "A list of tags assigned to a list member.", "required": ["tags"], "properties": {"tags": {"type": "array", "title": "Tags", "description": "A list of tags assigned to the list member.", "items": {"type": "object", "title": "Member Tag", "description": "Add or remove tags on a member by declaring a tag either active or inactive on a member.", "required": ["name", "status"], "properties": {"name": {"type": "string", "title": "Tag Name", "description": "The name of the tag."}, "status": {"type": "string", "title": "Status", "description": "The status for the tag on the member, pass in active to add a tag or inactive to remove it.", "enum": ["inactive", "active"]}}}}, "is_syncing": {"type": "boolean", "title": "Is Syncing", "description": "When is_syncing is true, automations based on the tags in the request will not fire"}}}',  # noqa: E501
    "ADDLISTMEMBEREVENT": '{"type": "object", "title": "Events", "description": "A new event for a specific list member", "required": ["name"], "properties": {"name": {"type": "string", "title": "Event Name", "description": "The name for this type of event (\'purchased\', \'visited\', etc). Must be 2-30 characters in length"}, "properties": {"type": "object", "title": "Properties", "description": "An optional list of properties", "additionalProperties": {"type": "string"}}, "is_syncing": {"type": "boolean", "title": "Is Syncing", "description": "Events created with the is_syncing value set to `true` will not trigger automations."}, "occurred_at": {"type": "string", "title": "Occurred Time", "description": "The date and time the event occurred in ISO 8601 format.", "format": "date-time"}}}',  # noqa: E501
    "ADDAUDIENCEMERGEFIELD": '{"type": "object", "title": "Merge Field", "description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.", "required": ["name", "type"], "properties": {"tag": {"type": "string", "title": "Merge Tag", "description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."}, "name": {"type": "string", "title": "Merge Field Name", "description": "The name of the merge field (audience field)."}, "type": {"type": "string", "title": "Merge Field Type", "description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.", "enum": ["text", "number", "address", "phone", "date", "url", "imageurl", "radio", "dropdown", "birthday", "zip"]}, "required": {"type": "boolean", "title": "Required", "description": "Whether the merge field is required to import a contact."}, "default_value": {"type": "string", "title": "Default Value", "description": "The default value for the merge field if `null`."}, "public": {"type": "boolean", "title": "Merge Field Public Status", "description": "Whether the merge field is displayed on the signup form."}, "display_order": {"type": "integer", "title": "Display Order", "description": "The order that the merge field displays on the list signup form."}, "options": {"type": "object", "title": "Merge Field Options", "description": "Extra options for some merge field types.", "properties": {"default_country": {"type": "integer", "title": "Default Country", "description": "In an address field, the default country code if none supplied.", "items": {"type": "string"}}, "phone_format": {"type": "string", "title": "Phone Type", "description": "In a phone field, the phone number type: US or International."}, "date_format": {"type": "string", "title": "Date Type", "description": "In a date or birthday field, the format of the date."}, "choices": {"type": "array", "title": "Choices", "description": "In a radio or dropdown non-group field, the available options for contacts to pick from.", "items": {"type": "string"}, "example": ["First Choice", "Second Choice", "Third Choice"]}, "size": {"type": "integer", "title": "Text Field Size", "description": "In a text field, the default length of the text field."}}}, "help_text": {"type": "string", "title": "Merge Field Help Text", "description": "Extra text to help the subscriber fill out the form."}}}',  # noqa: E501
    "UPDATEMERGEFIELD": '{"type": "object", "title": "Merge Field", "description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.", "required": ["name"], "properties": {"tag": {"type": "string", "title": "Merge Tag", "description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."}, "name": {"type": "string", "title": "Merge Field Name", "description": "The name of the merge field (audience field)."}, "required": {"type": "boolean", "title": "Required", "description": "Whether the merge field is required to import a contact."}, "default_value": {"type": "string", "title": "Default Value", "description": "The default value for the merge field if `null`."}, "public": {"type": "boolean", "title": "Merge Field Public Status", "description": "Whether the merge field is displayed on the signup form."}, "display_order": {"type": "integer", "title": "Display Order", "description": "The order that the merge field displays on the list signup form."}, "options": {"type": "object", "title": "Merge Field Options", "description": "Extra options for some merge field types.", "properties": {"default_country": {"type": "integer", "title": "Default Country", "description": "In an address field, the default country code if none supplied."}, "phone_format": {"type": "string", "title": "Phone Type", "description": "In a phone field, the phone number type: US or International."}, "date_format": {"type": "string", "title": "Date Type", "description": "In a date or birthday field, the format of the date."}, "choices": {"type": "array", "title": "Choices", "description": "In a radio or dropdown non-group field, the available options for members to pick from.", "items": {"type": "string"}, "example": ["First Choice", "Second Choice", "Third Choice"]}}}, "help_text": {"type": "string", "title": "Merge Field Help Text", "description": "Extra text to help the subscriber fill out the form."}}}',  # noqa: E501
    "CREATEMAILCHIMPWEBHOOK": '{"type": "object", "title": "Add Webhook", "description": "Configure a webhook for the given list.", "properties": {"url": {"type": "string", "title": "URL", "description": "A valid URL for the Webhook.", "example": "http://yourdomain.com/webhook"}, "events": {"type": "object", "title": "Events", "description": "The events that can trigger the webhook and whether they are enabled.", "properties": {"subscribe": {"type": "boolean", "title": "Subscribed", "description": "Whether the webhook is triggered when a list subscriber is added.", "example": true}, "unsubscribe": {"type": "boolean", "title": "Unsubscribed", "description": "Whether the webhook is triggered when a list member unsubscribes.", "example": true}, "profile": {"type": "boolean", "title": "Profile Updated", "description": "Whether the webhook is triggered when a subscriber\'s profile is updated.", "example": true}, "cleaned": {"type": "boolean", "title": "Cleaned", "description": "Whether the webhook is triggered when a subscriber\'s email address is cleaned from the list.", "example": true}, "upemail": {"type": "boolean", "title": "Email Address Updated", "description": "Whether the webhook is triggered when a subscriber\'s email address is changed.", "example": true}, "campaign": {"type": "boolean", "title": "Campaign Sent", "description": "Whether the webhook is triggered when a campaign is sent or cancelled.", "example": true}}}, "sources": {"type": "object", "title": "Sources", "description": "The possible sources of any events that can trigger the webhook and whether they are enabled.", "properties": {"user": {"type": "boolean", "title": "User", "description": "Whether the webhook is triggered by subscriber-initiated actions.", "example": true}, "admin": {"type": "boolean", "title": "Admin", "description": "Whether the webhook is triggered by admin-initiated actions in the web interface.", "example": true}, "api": {"type": "boolean", "title": "API", "description": "Whether the webhook is triggered by actions initiated via the API.", "example": true}}}}}',  # noqa: E501
    "UPDATEWEBHOOKSETTINGS": '{"type": "object", "title": "Add Webhook", "description": "Configure a webhook for the given list.", "properties": {"url": {"type": "string", "title": "URL", "description": "A valid URL for the Webhook.", "example": "http://yourdomain.com/webhook"}, "events": {"type": "object", "title": "Events", "description": "The events that can trigger the webhook and whether they are enabled.", "properties": {"subscribe": {"type": "boolean", "title": "Subscribed", "description": "Whether the webhook is triggered when a list subscriber is added.", "example": true}, "unsubscribe": {"type": "boolean", "title": "Unsubscribed", "description": "Whether the webhook is triggered when a list member unsubscribes.", "example": true}, "profile": {"type": "boolean", "title": "Profile Updated", "description": "Whether the webhook is triggered when a subscriber\'s profile is updated.", "example": true}, "cleaned": {"type": "boolean", "title": "Cleaned", "description": "Whether the webhook is triggered when a subscriber\'s email address is cleaned from the list.", "example": true}, "upemail": {"type": "boolean", "title": "Email Address Updated", "description": "Whether the webhook is triggered when a subscriber\'s email address is changed.", "example": true}, "campaign": {"type": "boolean", "title": "Campaign Sent", "description": "Whether the webhook is triggered when a campaign is sent or cancelled.", "example": true}}}, "sources": {"type": "object", "title": "Sources", "description": "The possible sources of any events that can trigger the webhook and whether they are enabled.", "properties": {"user": {"type": "boolean", "title": "User", "description": "Whether the webhook is triggered by subscriber-initiated actions.", "example": true}, "admin": {"type": "boolean", "title": "Admin", "description": "Whether the webhook is triggered by admin-initiated actions in the web interface.", "example": true}, "api": {"type": "boolean", "title": "API", "description": "Whether the webhook is triggered by actions initiated via the API.", "example": true}}}}}',  # noqa: E501
    "CUSTOMIZELISTSIGNUPFORM": '{"type": "object", "title": "Signup Form", "description": "List signup form.", "properties": {"header": {"type": "object", "title": "Signup form header options", "description": "Options for customizing your signup form header.", "properties": {"image_url": {"type": "string", "title": "Header Image URL", "description": "Header image URL.", "example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png"}, "text": {"type": "string", "title": "Header Text", "description": "Header text.", "example": "Header Text goes here"}, "image_width": {"type": "string", "title": "Image width", "description": "Image width, in pixels.", "example": "800"}, "image_height": {"type": "string", "title": "Image height", "description": "Image height, in pixels.", "example": "200"}, "image_alt": {"type": "string", "title": "Image Alt", "description": "Alt text for the image.", "example": "This is an image"}, "image_link": {"type": "string", "title": "Image Link", "description": "The URL that the header image will link to.", "example": "gotothisimage.com"}, "image_align": {"type": "string", "title": "Image align", "description": "Image alignment.", "enum": ["none", "left", "center", "right"], "example": "center"}, "image_border_width": {"type": "string", "title": "Image border width", "description": "Image border width.", "example": "2"}, "image_border_style": {"type": "string", "title": "Image border style", "description": "Image border style.", "enum": ["none", "solid", "dotted", "dashed", "double", "groove", "outset", "inset", "ridge"], "example": "solid"}, "image_border_color": {"type": "string", "title": "Image border color", "description": "Image border color.", "example": "#896d6d"}, "image_target": {"type": "string", "title": "Image target", "description": "Image link target.", "enum": ["_blank", "null"], "example": "_blank"}}}, "contents": {"type": "array", "items": {"type": "object", "title": "Collection of Content for List Signup Forms", "description": "Collection of Content for List Signup Forms.", "properties": {"section": {"type": "string", "title": "Content Section Name", "description": "The content section name.", "enum": ["signup_message", "unsub_message", "signup_thank_you_title"], "example": "signup_message"}, "value": {"type": "string", "title": "Content Section Value", "description": "The content section text.", "example": "Signup message goes here"}}}, "title": "Signup form body content", "description": "The signup form body content."}, "styles": {"type": "array", "items": {"type": "object", "title": "Collection of Element style for List Signup Forms", "description": "Collection of Element style for List Signup Forms.", "properties": {"selector": {"type": "string", "title": "Selector", "description": "A string that identifies the element selector.", "enum": ["page_background", "page_header", "page_outer_wrapper", "body_background", "body_link_style", "forms_buttons", "forms_buttons_hovered", "forms_field_label", "forms_field_text", "forms_required", "forms_required_legend", "forms_help_text", "forms_errors", "monkey_rewards_badge"], "example": "page_background"}, "options": {"type": "array", "title": "Options", "description": "A collection of options for a selector.", "items": {"type": "object", "title": "An option for Signup Form Styles", "description": "An option for Signup Form Styles.", "properties": {"property": {"type": "string", "title": "Property", "description": "A string that identifies the property.", "example": "background-color"}, "value": {"type": "string", "title": "Value", "description": "A string that identifies value of the property.", "example": "#111111"}}}}}}, "title": "Signup Form element style", "description": "An array of objects, each representing an element style for the signup form."}}}',  # noqa: E501
    "ADDNEWECOMMERCESTORE": '{"type": "object", "title": "E-commerce Store", "description": "An individual store in an account.", "required": ["id", "list_id", "name", "currency_code"], "properties": {"id": {"type": "string", "title": "Store Foreign ID", "description": "The unique identifier for the store.", "example": "example_store"}, "list_id": {"type": "string", "title": "List ID", "description": "The unique identifier for the list associated with the store. The `list_id` for a specific store cannot change.", "example": "1a2df69511"}, "name": {"type": "string", "title": "Store Name", "description": "The name of the store.", "example": "Freddie\'s Cat Hat Emporium"}, "platform": {"type": "string", "title": "Platform", "description": "The e-commerce platform of the store."}, "domain": {"type": "string", "title": "Domain", "description": "The store domain. This parameter is required for Connected Sites and Google Ads.", "example": "example.com"}, "is_syncing": {"type": "boolean", "title": "Is Syncing", "description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."}, "email_address": {"type": "string", "title": "Email Address", "description": "The email address for the store.", "example": "freddie@mailchimp.com"}, "currency_code": {"type": "string", "title": "Currency", "description": "The three-letter ISO 4217 code for the currency that the store accepts.", "example": "USD"}, "money_format": {"type": "string", "title": "Money Format", "description": "The currency format for the store. For example: `$`, `\u00a3`, etc.", "example": "$"}, "primary_locale": {"type": "string", "title": "Primary Locale", "description": "The primary locale for the store. For example: `en`, `de`, etc.", "example": "fr"}, "timezone": {"type": "string", "title": "Timezone", "description": "The timezone for the store.", "example": "Eastern"}, "phone": {"type": "string", "title": "Phone", "description": "The store phone number.", "example": "+16155550128"}, "address": {"type": "object", "title": "Address", "description": "The store address.", "properties": {"address1": {"type": "string", "title": "Address Field 1", "description": "The store\'s mailing address.", "example": "675 Ponce de Leon Ave NE"}, "address2": {"type": "string", "title": "Address Field 2", "description": "An additional field for the store\'s mailing address.", "example": "Suite 5000"}, "city": {"type": "string", "title": "City ", "description": "The city the store is located in.", "example": "Atlanta"}, "province": {"type": "string", "title": "Province", "description": "The store\'s state name or normalized province.", "example": "Georgia"}, "province_code": {"type": "string", "title": "Province Code", "description": "The two-letter code for the store\'s province or state.", "example": "GA"}, "postal_code": {"type": "string", "title": "Postal Code", "description": "The store\'s postal or zip code.", "example": "30308"}, "country": {"type": "string", "title": "Country Code", "description": "The store\'s country.", "example": "United States"}, "country_code": {"type": "string", "title": "Country Code", "description": "The two-letter code for to the store\'s country.", "example": "US"}, "longitude": {"type": "number", "title": "Longitude", "description": "The longitude of the store location.", "example": -75.68903}, "latitude": {"type": "number", "title": "Latitude", "description": "The latitude of the store location.", "example": 45.427408}}}}}',  # noqa: E501
    "UPDATEECOMMERCESTORE": '{"type": "object", "title": "E-commerce Store", "description": "An individual store in an account.", "properties": {"name": {"type": "string", "title": "Store Name", "description": "The name of the store.", "example": "Freddie\'s Cat Hat Emporium"}, "platform": {"type": "string", "title": "Platform", "description": "The e-commerce platform of the store."}, "domain": {"type": "string", "title": "Domain", "description": "The store domain.", "example": "example.com"}, "is_syncing": {"type": "boolean", "title": "Is Syncing", "description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."}, "email_address": {"type": "string", "title": "Email Address", "description": "The email address for the store.", "example": "freddie@mailchimp.com"}, "currency_code": {"type": "string", "title": "Currency", "description": "The three-letter ISO 4217 code for the currency that the store accepts.", "example": "USD"}, "money_format": {"type": "string", "title": "Money Format", "description": "The currency format for the store. For example: `$`, `\u00a3`, etc.", "example": "$"}, "primary_locale": {"type": "string", "title": "Primary Locale", "description": "The primary locale for the store. For example: `en`, `de`, etc.", "example": "fr"}, "timezone": {"type": "string", "title": "Timezone", "description": "The timezone for the store.", "example": "Eastern"}, "phone": {"type": "string", "title": "Phone", "description": "The store phone number.", "example": "+16155550128"}, "address": {"type": "object", "title": "Address", "description": "The store address.", "properties": {"address1": {"type": "string", "title": "Address Field 1", "description": "The store\'s mailing address.", "example": "675 Ponce de Leon Ave NE"}, "address2": {"type": "string", "title": "Address Field 2", "description": "An additional field for the store\'s mailing address.", "example": "Suite 5000"}, "city": {"type": "string", "title": "City ", "description": "The city the store is located in.", "example": "Atlanta"}, "province": {"type": "string", "title": "Province", "description": "The store\'s state name or normalized province.", "example": "Georgia"}, "province_code": {"type": "string", "title": "Province Code", "description": "The two-letter code for the store\'s province or state.", "example": "GA"}, "postal_code": {"type": "string", "title": "Postal Code", "description": "The store\'s postal or zip code.", "example": "30308"}, "country": {"type": "string", "title": "Country Code", "description": "The store\'s country.", "example": "United States"}, "country_code": {"type": "string", "title": "Country Code", "description": "The two-letter code for to the store\'s country.", "example": "US"}, "longitude": {"type": "number", "title": "Longitude", "description": "The longitude of the store location.", "example": -75.68903}, "latitude": {"type": "number", "title": "Latitude", "description": "The latitude of the store location.", "example": 45.427408}}}}}',  # noqa: E501
    "ADDCARTTOSTORE": '{"type": "object", "title": "E-commerce Cart", "description": "Information about a specific cart.", "required": ["id", "currency_code", "customer", "order_total", "lines"], "properties": {"id": {"type": "string", "title": "Cart Foreign ID", "description": "A unique identifier for the cart."}, "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 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.", "required": ["id", "product_id", "product_variant_id", "quantity", "price"], "properties": {"id": {"type": "string", "title": "Cart Line Item Foreign ID", "description": "A unique identifier for the cart line item."}, "product_id": {"type": "string", "title": "Cart Line Product Foreign ID", "description": "A unique identifier for the product associated with the cart line item."}, "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."}, "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."}}}}}}',  # noqa: E501
    "UPDATECART": '{"type": "object", "title": "E-commerce Cart", "description": "Information about a specific cart.", "properties": {"customer": {"type": "object", "title": "E-commerce Customer", "description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body.", "properties": {"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 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": {"product_id": {"type": "string", "title": "Cart Line Product Foreign ID", "description": "A unique identifier for the product associated with the cart line item."}, "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."}, "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."}}}}}}',  # noqa: E501
    "ADDCUSTOMERTOSTORE": '{"type": "object", "title": "E-commerce Customer", "description": "Information about a specific customer.", "required": ["id", "opt_in_status"], "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."}, "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."}, "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"}}}}}',  # noqa: E501
    "ADDORUPDATECUSTOMERINSTORE": '{"type": "object", "title": "E-commerce Customer", "description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body.", "required": ["id", "opt_in_status"], "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."}, "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."}, "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"}}}}}',  # noqa: E501
    "UPDATECUSTOMERINFO": '{"type": "object", "title": "E-commerce Customer", "description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body.", "properties": {"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"}}}}}',  # noqa: E501
    "ADDSTOREPROMORULE": '{"type": "object", "title": "E-commerce Promo Rule", "description": "Information about an Ecommerce Store\'s specific Promo Rule.", "required": ["id", "description", "amount", "type", "target"], "properties": {"id": {"type": "string", "title": "Promo Rule Foreign ID", "description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."}, "title": {"type": "string", "title": "Title", "description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes.", "example": "50% off Total Order"}, "description": {"type": "string", "title": "Description", "description": "The description of a promotion restricted to UTF-8 characters with max length 255.", "example": "Save BIG during our summer sale!"}, "starts_at": {"type": "string", "format": "date-time", "title": "Promo Start Time", "description": "The date and time when the promotion is in effect in ISO 8601 format."}, "ends_at": {"type": "string", "format": "Promo date-time", "title": "End Time", "description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."}, "amount": {"type": "number", "title": "Amount", "format": "float", "description": "The amount of the promo code discount. If \'type\' is \'fixed\', the amount is treated as a monetary value. If \'type\' is \'percentage\', amount must be a decimal value between 0.0 and 1.0, inclusive.", "example": 0.5}, "type": {"type": "string", "title": "Type", "description": "Type of discount. For free shipping set type to fixed.", "enum": ["fixed", "percentage"]}, "target": {"type": "string", "title": "Target", "description": "The target that the discount applies to.", "enum": ["per_item", "total", "shipping"]}, "enabled": {"type": "boolean", "title": "Enabled", "description": "Whether the promo rule is currently enabled.", "example": "true"}, "created_at_foreign": {"type": "string", "format": "date-time", "title": "Foreign Create Time", "description": "The date and time the promotion was created in ISO 8601 format."}, "updated_at_foreign": {"type": "string", "format": "date-time", "title": "Foreign Update Time", "description": "The date and time the promotion was updated in ISO 8601 format."}}}',  # noqa: E501
    "UPDATEPROMORULE": '{"type": "object", "title": "E-commerce Promo Rule", "description": "Information about an Ecommerce Store\'s specific Promo Rule.", "properties": {"title": {"type": "string", "title": "Title", "description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes.", "example": "50% off Total Order"}, "description": {"type": "string", "title": "Description", "description": "The description of a promotion restricted to UTF-8 characters with max length 255.", "example": "Save BIG during our summer sale!"}, "starts_at": {"type": "string", "format": "date-time", "title": "Promo Start Time", "description": "The date and time when the promotion is in effect in ISO 8601 format."}, "ends_at": {"type": "string", "format": "Promo date-time", "title": "End Time", "description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."}, "amount": {"type": "number", "title": "Amount", "format": "float", "description": "The amount of the promo code discount. If \'type\' is \'fixed\', the amount is treated as a monetary value. If \'type\' is \'percentage\', amount must be a decimal value between 0.0 and 1.0, inclusive.", "example": 0.5}, "type": {"type": "string", "title": "Type", "description": "Type of discount. For free shipping set type to fixed.", "enum": ["fixed", "percentage"]}, "target": {"type": "string", "title": "Target", "description": "The target that the discount applies to.", "enum": ["per_item", "total", "shipping"]}, "enabled": {"type": "boolean", "title": "Enabled", "description": "Whether the promo rule is currently enabled.", "example": "true"}, "created_at_foreign": {"type": "string", "format": "date-time", "title": "Foreign Create Time", "description": "The date and time the promotion was created in ISO 8601 format."}, "updated_at_foreign": {"type": "string", "format": "date-time", "title": "Foreign Update Time", "description": "The date and time the promotion was updated in ISO 8601 format."}}}',  # noqa: E501
    "ADDORDERTOSTORE": '{"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"}, "cart_id": {"type": "string", "title": "Cart ID", "description": "A cart id that the order was placed for.", "example": "cart-123"}, "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.68903}, "latitude": {"type": "number", "title": "Latitude", "description": "The latitude for the shipping address location.", "example": 45.427408}, "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.68903}, "latitude": {"type": "number", "title": "Latitude", "description": "The latitude for the billing address location.", "example": 45.427408}, "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."}}}',  # noqa: E501
    "UPDATEECOMMERCEORDER": '{"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."}, "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": "405 N Angier Ave NE"}, "address2": {"type": "string", "title": "Address Field 2", "description": "An additional field for the customer\'s mailing address."}, "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", "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"}, "cart_id": {"type": "string", "title": "Cart ID", "description": "A cart id that the order was placed for.", "example": "cart-123"}, "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": "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. 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": "2024-09-10T17:27:43+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": "405 N Angier Ave NE"}, "address2": {"type": "string", "title": "Address Field 2", "description": "An additional field for the shipping address."}, "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", "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": -84.362887}, "latitude": {"type": "number", "title": "Latitude", "description": "The latitude for the shipping address location.", "example": 33.768526}, "phone": {"type": "string", "title": "Phone Number", "description": "The phone number for the order\'s shipping address.", "example": "+16155550128"}, "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": "405 N Angier Ave NE"}, "address2": {"type": "string", "title": "Address Field 2", "description": "An additional field for the billing address."}, "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", "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": -84.362887}, "latitude": {"type": "number", "title": "Latitude", "description": "The latitude for the billing address location.", "example": 33.768526}, "phone": {"type": "string", "title": "Phone Number", "description": "The phone number for the billing address", "example": "+16155550128"}, "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"], "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"], "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."}}}',  # noqa: E501
    "UPDATEORDERMAILCHIMP": '{"type": "object", "title": "E-commerce Order", "description": "Information about a specific order.", "properties": {"customer": {"type": "object", "title": "E-commerce Customer", "description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body.", "properties": {"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 associated with an order.", "example": "839488a60b"}, "cart_id": {"type": "string", "title": "Cart ID", "description": "A cart id that the order was placed for.", "example": "cart-123"}, "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. Note: passing a value for this parameter will cancel the order being edited.", "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.68903}, "latitude": {"type": "number", "title": "Latitude", "description": "The latitude for the shipping address location.", "example": 45.427408}, "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.68903}, "latitude": {"type": "number", "title": "Latitude", "description": "The latitude for the billing address location.", "example": 45.427408}, "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. Note: Patch will completely replace the value of promos with the new one provided.", "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.", "properties": {"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."}, "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."}}}',  # noqa: E501
    "ADDORDERLINEITEM": '{"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."}}}',  # noqa: E501
    "ADDPRODUCTTOSTORE": '{"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"}}}',  # noqa: E501
    "UPDATEPRODUCTINFO": '{"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."}}}}, "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"}}}}}, "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"}}}',  # noqa: E501
    "UPDATEECOMMERCEPRODUCT": '{"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"}}}',  # noqa: E501
    "ADDPRODUCTVARIANTMAILCHIMP": '{"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."}}}',  # noqa: E501
    "UPDATEPRODUCTVARIANT": '{"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."}}}',  # noqa: E501
    "MODIFYPRODUCTVARIANT": '{"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."}}}',  # noqa: E501
}
