openapi: 3.0.0 servers: - url: https://server.api.mailchimp.com/3.0 info: contact: email: apihelp@mailchimp.com name: Mailchimp API Support title: Mailchimp Marketing API version: 3.0.55 x-apisguru-categories: - messaging x-logo: url: https://eep.io/images/yzco4xsimv0y/10ZRu9hZ1QQ5u1QQMu7qN1/57f679c6e8f6dd60a01d54f870fae6b7/MC_50-50_-_Brand_Assets_03.png?w=980&fm=webp&q=70 x-origin: - format: swagger url: https://api.mailchimp.com/schema/3.0/Swagger.json?expand version: "2.0" x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json x-providerName: mailchimp.com externalDocs: description: Learn more with the full Mailchimp API documentation. url: https://mailchimp.com/developer/marketing/ security: - basicAuth: [] paths: /: get: deprecated: false description: Get links to all other resources available in the API. operationId: getRoot parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields responses: "200": content: application/json: schema: description: The API root resource links to all other resources available in the API. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array account_id: description: The Mailchimp account ID. readOnly: true title: Account ID type: string account_industry: description: The user-specified industry associated with the account. readOnly: true title: Account Industry type: string account_name: description: The name of the account. readOnly: true title: Account Name type: string account_timezone: description: The timezone currently set for the account. readOnly: true title: Account Timezone type: string avatar_url: description: URL of the avatar for the user. readOnly: true title: Avatar URL type: string contact: description: Information about the account contact. properties: addr1: description: The street address for the account contact. readOnly: true title: Address Line 1 type: string addr2: description: The street address for the account contact. readOnly: true title: Address Line 2 type: string city: description: The city for the account contact. readOnly: true title: City type: string company: description: The company name for the account. readOnly: true title: Company type: string country: description: The country for the account contact. readOnly: true title: Country type: string state: description: The state for the account contact. readOnly: true title: State type: string zip: description: The zip code for the account contact. readOnly: true title: Zip Code type: string readOnly: true title: Account Contact type: object email: description: The account email address. readOnly: true title: Account Email type: string first_name: description: The first name tied to the account. readOnly: true title: First Name type: string first_payment: description: Date of first payment for monthly plans. example: 2010-01-01T23:59:59+00:00 format: date-time readOnly: true title: First Payment type: string industry_stats: description: The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry. properties: bounce_rate: description: The average bounce rate for all campaigns in the account's specified industry. readOnly: true title: Bounce Rate type: number click_rate: description: The average unique click rate for all campaigns in the account's specified industry. readOnly: true title: Click Rate type: number open_rate: description: The average unique open rate for all campaigns in the account's specified industry. readOnly: true title: Open Rate type: number readOnly: true title: Industry Stats type: object last_login: description: The date and time of the last login for this account in ISO 8601 format. format: date-time readOnly: true title: Last Login Date type: string last_name: description: The last name tied to the account. readOnly: true title: Last Name type: string login_id: description: The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account. readOnly: true title: Login ID type: string member_since: description: The date and time that the account was created in ISO 8601 format. example: 2010-01-01T23:59:59+00:00 format: date-time readOnly: true title: Account Creation Date type: string pricing_plan_type: description: The type of pricing plan the account is on. enum: - monthly - pay_as_you_go - forever_free readOnly: true title: Account Pricing Plan type: string pro_enabled: description: Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-mailchimp-pro/). readOnly: true title: Mailchimp Pro type: boolean role: description: The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account. readOnly: true title: Role type: string total_subscribers: description: The total number of subscribers across all lists in the account. readOnly: true title: Total Subscribers type: integer username: description: The username tied to the account. example: freddie2000 readOnly: true title: User Name type: string title: API Root type: object application/problem+json: schema: description: The API root resource links to all other resources available in the API. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array account_id: description: The Mailchimp account ID. readOnly: true title: Account ID type: string account_industry: description: The user-specified industry associated with the account. readOnly: true title: Account Industry type: string account_name: description: The name of the account. readOnly: true title: Account Name type: string account_timezone: description: The timezone currently set for the account. readOnly: true title: Account Timezone type: string avatar_url: description: URL of the avatar for the user. readOnly: true title: Avatar URL type: string contact: description: Information about the account contact. properties: addr1: description: The street address for the account contact. readOnly: true title: Address Line 1 type: string addr2: description: The street address for the account contact. readOnly: true title: Address Line 2 type: string city: description: The city for the account contact. readOnly: true title: City type: string company: description: The company name for the account. readOnly: true title: Company type: string country: description: The country for the account contact. readOnly: true title: Country type: string state: description: The state for the account contact. readOnly: true title: State type: string zip: description: The zip code for the account contact. readOnly: true title: Zip Code type: string readOnly: true title: Account Contact type: object email: description: The account email address. readOnly: true title: Account Email type: string first_name: description: The first name tied to the account. readOnly: true title: First Name type: string first_payment: description: Date of first payment for monthly plans. example: 2010-01-01T23:59:59+00:00 format: date-time readOnly: true title: First Payment type: string industry_stats: description: The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry. properties: bounce_rate: description: The average bounce rate for all campaigns in the account's specified industry. readOnly: true title: Bounce Rate type: number click_rate: description: The average unique click rate for all campaigns in the account's specified industry. readOnly: true title: Click Rate type: number open_rate: description: The average unique open rate for all campaigns in the account's specified industry. readOnly: true title: Open Rate type: number readOnly: true title: Industry Stats type: object last_login: description: The date and time of the last login for this account in ISO 8601 format. format: date-time readOnly: true title: Last Login Date type: string last_name: description: The last name tied to the account. readOnly: true title: Last Name type: string login_id: description: The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account. readOnly: true title: Login ID type: string member_since: description: The date and time that the account was created in ISO 8601 format. example: 2010-01-01T23:59:59+00:00 format: date-time readOnly: true title: Account Creation Date type: string pricing_plan_type: description: The type of pricing plan the account is on. enum: - monthly - pay_as_you_go - forever_free readOnly: true title: Account Pricing Plan type: string pro_enabled: description: Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-mailchimp-pro/). readOnly: true title: Mailchimp Pro type: boolean role: description: The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account. readOnly: true title: Role type: string total_subscribers: description: The total number of subscribers across all lists in the account. readOnly: true title: Total Subscribers type: integer username: description: The username tied to the account. example: freddie2000 readOnly: true title: User Name type: string title: API Root type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List api root resources tags: - root x-custom-config: methodNameCamel: getRoot methodNameSnake: get_root /account-exports: get: deprecated: false description: Get a list of account exports for a given account. operationId: getAccountExports parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset responses: "200": content: application/json: schema: description: An array of objects, each representing an account export. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array exports: description: An array of objects, each representing an account export. items: description: An account export. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array download_url: description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. title: Download URL type: string export_id: description: The ID for the export. title: Export ID type: integer finished: description: If finished, the finish time for the export. format: date-time title: Finish Time type: string size_in_bytes: description: The size of the uncompressed export in bytes. title: Export Size type: integer started: description: Start time for the export. format: date-time title: Start Time type: string type: object title: Account Exports type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object application/problem+json: schema: description: An array of objects, each representing an account export. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array exports: description: An array of objects, each representing an account export. items: description: An account export. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array download_url: description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. title: Download URL type: string export_id: description: The ID for the export. title: Export ID type: integer finished: description: If finished, the finish time for the export. format: date-time title: Finish Time type: string size_in_bytes: description: The size of the uncompressed export in bytes. title: Export Size type: integer started: description: Start time for the export. format: date-time title: Start Time type: string type: object title: Account Exports type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List account exports tags: - accountExports x-custom-config: methodNameCamel: listAccountExports methodNameSnake: list_account_exports post: deprecated: false description: Create a new account export in your Mailchimp account. operationId: postAccountExport requestBody: content: application/json: schema: description: Creates an account export with the given parameters. properties: include_stages: description: The stages of an account export to include. example: '["audiences", "gallery_files"]' items: enum: - audiences - campaigns - events - gallery_files - reports - templates type: string title: Include Stages type: array since_timestamp: description: An ISO 8601 date that will limit the export to only records created after a given time. For instance, the reports stage will contain any campaign sent after the given timestamp. Audiences, however, are excluded from this limit. example: 2021-08-23T14:15:09Z format: date-time title: Since Timestamp type: string required: - include_stages title: Create an account export type: object required: true responses: "200": content: application/json: schema: description: An account export. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array download_url: description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. title: Download URL type: string export_id: description: The ID for the export. title: Export ID type: integer finished: description: If finished, the finish time for the export. format: date-time title: Finish Time type: string size_in_bytes: description: The size of the uncompressed export in bytes. title: Export Size type: integer started: description: Start time for the export. format: date-time title: Start Time type: string type: object application/problem+json: schema: description: An account export. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array download_url: description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. title: Download URL type: string export_id: description: The ID for the export. title: Export ID type: integer finished: description: If finished, the finish time for the export. format: date-time title: Finish Time type: string size_in_bytes: description: The size of the uncompressed export in bytes. title: Export Size type: integer started: description: Start time for the export. format: date-time title: Start Time type: string type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add export tags: - accountExports x-custom-config: methodNameCamel: createAccountExport methodNameSnake: create_account_export "/account-exports/{export_id}": get: deprecated: false description: Get information about a specific account export. operationId: getAccountExportId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the account export. in: path name: export_id required: true schema: type: string x-title: Export ID responses: "200": content: application/json: schema: description: An account export. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array download_url: description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. title: Download URL type: string export_id: description: The ID for the export. title: Export ID type: integer finished: description: If finished, the finish time for the export. format: date-time title: Finish Time type: string size_in_bytes: description: The size of the uncompressed export in bytes. title: Export Size type: integer started: description: Start time for the export. format: date-time title: Start Time type: string type: object application/problem+json: schema: description: An account export. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array download_url: description: If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. title: Download URL type: string export_id: description: The ID for the export. title: Export ID type: integer finished: description: If finished, the finish time for the export. format: date-time title: Finish Time type: string size_in_bytes: description: The size of the uncompressed export in bytes. title: Export Size type: integer started: description: Start time for the export. format: date-time title: Start Time type: string type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get account export info tags: - accountExport x-custom-config: methodNameCamel: getAccountExports methodNameSnake: get_account_exports /activity-feed/chimp-chatter: get: description: Return the Chimp Chatter for this account ordered by most recent. operationId: getActivityFeedChimpChatter parameters: - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset responses: "200": content: application/json: schema: description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array chimp_chatter: description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account. items: description: A Chimp Chatter message properties: campaign_id: description: If it exists, campaign ID for the associated campaign example: 2017-08-04T11:09:01+00:00 readOnly: true title: Campaign ID type: string list_id: description: If it exists, list ID for the associated list example: 2017-08-04T11:09:01+00:00 readOnly: true title: List ID type: string message: example: People are telling their friends about your campaign! readOnly: true title: Message type: string title: example: 1 new subscriber to Your New Campaign! readOnly: true title: Title type: string type: description: The type of activity enum: - lists:new-subscriber - lists:unsubscribes - lists:profile-updates - campaigns:facebook-likes - campaigns:forward-to-friend - lists:imports example: campaigns:forward-to-friend readOnly: true title: Type type: string update_time: description: The date and time this activity was updated. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Update Time type: string url: description: URL to a report that includes this activity example: http://dev.mailchimp.com/reports/summary?id=1 readOnly: true title: URL type: string title: ChimpChatter type: object readOnly: true type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object application/problem+json: schema: description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array chimp_chatter: description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account. items: description: A Chimp Chatter message properties: campaign_id: description: If it exists, campaign ID for the associated campaign example: 2017-08-04T11:09:01+00:00 readOnly: true title: Campaign ID type: string list_id: description: If it exists, list ID for the associated list example: 2017-08-04T11:09:01+00:00 readOnly: true title: List ID type: string message: example: People are telling their friends about your campaign! readOnly: true title: Message type: string title: example: 1 new subscriber to Your New Campaign! readOnly: true title: Title type: string type: description: The type of activity enum: - lists:new-subscriber - lists:unsubscribes - lists:profile-updates - campaigns:facebook-likes - campaigns:forward-to-friend - lists:imports example: campaigns:forward-to-friend readOnly: true title: Type type: string update_time: description: The date and time this activity was updated. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Update Time type: string url: description: URL to a report that includes this activity example: http://dev.mailchimp.com/reports/summary?id=1 readOnly: true title: URL type: string title: ChimpChatter type: object readOnly: true type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object description: ChimpChatter Collection default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get latest chimp chatter tags: - activityFeed x-custom-config: methodNameCamel: getChimpChatter methodNameSnake: get_chimp_chatter /authorized-apps: get: deprecated: false description: Get a list of an account's registered, connected applications. operationId: getAuthorizedApps parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset responses: "200": content: application/json: schema: description: An array of objects, each representing an authorized application. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array apps: description: An array of objects, each representing an authorized application. items: description: An authorized app. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array description: description: A short description of the application. title: Application Description type: string id: description: The ID for the application. title: Client ID type: integer name: description: The name of the application. title: Application Name type: string users: description: An array of usernames for users who have linked the app. items: type: string title: Application Users type: array type: object title: Authorized Applications type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object application/problem+json: schema: description: An array of objects, each representing an authorized application. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array apps: description: An array of objects, each representing an authorized application. items: description: An authorized app. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array description: description: A short description of the application. title: Application Description type: string id: description: The ID for the application. title: Client ID type: integer name: description: The name of the application. title: Application Name type: string users: description: An array of usernames for users who have linked the app. items: type: string title: Application Users type: array type: object title: Authorized Applications type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List authorized apps tags: - authorizedApps x-custom-config: methodNameCamel: list methodNameSnake: list "/authorized-apps/{app_id}": get: deprecated: false description: Get information about a specific authorized application. operationId: getAuthorizedAppsId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the connected authorized application. in: path name: app_id required: true schema: type: string x-title: App ID responses: "200": content: application/json: schema: description: An authorized app. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array description: description: A short description of the application. title: Application Description type: string id: description: The ID for the application. title: Client ID type: integer name: description: The name of the application. title: Application Name type: string users: description: An array of usernames for users who have linked the app. items: type: string title: Application Users type: array type: object application/problem+json: schema: description: An authorized app. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array description: description: A short description of the application. title: Application Description type: string id: description: The ID for the application. title: Client ID type: integer name: description: The name of the application. title: Application Name type: string users: description: An array of usernames for users who have linked the app. items: type: string title: Application Users type: array type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get authorized app info tags: - authorizedApps x-custom-config: methodNameCamel: get methodNameSnake: get /automations: get: deprecated: false description: Get a summary of an account's classic automations. operationId: getAutomations parameters: - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: "Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_create_time required: false schema: format: date-time type: string x-title: Before Create Time - description: "Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_create_time required: false schema: format: date-time type: string x-title: Since Create Time - description: "Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_start_time required: false schema: format: date-time type: string x-title: Before Start Time - description: "Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_start_time required: false schema: format: date-time type: string x-title: Since Start Time - description: Restrict the results to automations with the specified status. in: query name: status required: false schema: enum: - save - paused - sending type: string x-title: Status responses: "200": content: application/json: schema: description: An array of objects, each representing an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array automations: description: An array of objects, each representing an Automation workflow. items: description: A summary of an individual Automation workflow's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array create_time: description: The date and time the Automation was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string emails_sent: description: The total number of emails sent for the Automation. readOnly: true title: Emails Sent type: integer id: description: A string that identifies the Automation. readOnly: true title: Automation Campaign ID type: string recipients: description: List settings for the Automation. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: List Name. title: List Name type: string segment_opts: description: An object representing all segmentation options. properties: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object store_id: description: The id of the store. example: 1a2df69xxx title: Store ID type: string title: List type: object report_summary: description: A summary of opens and clicks for sent campaigns. properties: click_rate: description: The number of unique clicks, divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object settings: description: The settings for the Automation workflow. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`. title: Authentication type: boolean auto_footer: description: Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation. title: Auto-Footer type: boolean from_name: description: The 'from' name for the Automation (not an email address). title: From Name type: string inline_css: description: Whether to automatically inline the CSS included with the Automation content. title: Inline CSS type: boolean reply_to: description: The reply-to email address for the Automation. title: Reply To Address type: string title: description: The title of the Automation. title: Automation Title type: string to_name: description: The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Whether to use Mailchimp Conversation feature to manage replies title: Conversations type: boolean title: Automation Campaign Settings type: object start_time: description: The date and time the Automation was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the Automation. enum: - save - paused - sending readOnly: true title: Automation Status type: string tracking: description: The tracking options for the Automation. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`. title: Plain-Text Click Tracking type: boolean title: Automation Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object title: Automation Workflow type: object title: Automation Workflows type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object application/problem+json: schema: description: An array of objects, each representing an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array automations: description: An array of objects, each representing an Automation workflow. items: description: A summary of an individual Automation workflow's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array create_time: description: The date and time the Automation was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string emails_sent: description: The total number of emails sent for the Automation. readOnly: true title: Emails Sent type: integer id: description: A string that identifies the Automation. readOnly: true title: Automation Campaign ID type: string recipients: description: List settings for the Automation. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: List Name. title: List Name type: string segment_opts: description: An object representing all segmentation options. properties: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object store_id: description: The id of the store. example: 1a2df69xxx title: Store ID type: string title: List type: object report_summary: description: A summary of opens and clicks for sent campaigns. properties: click_rate: description: The number of unique clicks, divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object settings: description: The settings for the Automation workflow. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`. title: Authentication type: boolean auto_footer: description: Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation. title: Auto-Footer type: boolean from_name: description: The 'from' name for the Automation (not an email address). title: From Name type: string inline_css: description: Whether to automatically inline the CSS included with the Automation content. title: Inline CSS type: boolean reply_to: description: The reply-to email address for the Automation. title: Reply To Address type: string title: description: The title of the Automation. title: Automation Title type: string to_name: description: The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Whether to use Mailchimp Conversation feature to manage replies title: Conversations type: boolean title: Automation Campaign Settings type: object start_time: description: The date and time the Automation was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the Automation. enum: - save - paused - sending readOnly: true title: Automation Status type: string tracking: description: The tracking options for the Automation. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`. title: Plain-Text Click Tracking type: boolean title: Automation Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object title: Automation Workflow type: object title: Automation Workflows type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List automations tags: - automations x-custom-config: methodNameCamel: list methodNameSnake: list post: deprecated: false description: Create a new classic automation in your Mailchimp account. operationId: postAutomations requestBody: content: application/json: schema: description: A summary of an individual Automation workflow's settings and content. properties: recipients: description: List settings for the Automation. properties: list_id: description: The id of the List. example: 1a2df69xxx title: List ID type: string store_id: description: The id of the store. example: 1a2df69xxx title: Store ID type: string title: List type: object settings: description: The settings for the Automation workflow. properties: from_name: description: The 'from' name for the Automation (not an email address). title: From Name type: string reply_to: description: The reply-to email address for the Automation. title: Reply To Address type: string title: Automation Campaign Settings type: object trigger_settings: description: Trigger settings for the Automation. properties: workflow_type: description: The type of Automation workflow. Currently only supports 'abandonedCart'. title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object required: - recipients - trigger_settings title: Automation Workflow type: object required: true responses: "200": content: application/json: schema: description: A summary of an individual Automation workflow's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array create_time: description: The date and time the Automation was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string emails_sent: description: The total number of emails sent for the Automation. readOnly: true title: Emails Sent type: integer id: description: A string that identifies the Automation. readOnly: true title: Automation Campaign ID type: string recipients: description: List settings for the Automation. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: List Name. title: List Name type: string segment_opts: description: An object representing all segmentation options. properties: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object store_id: description: The id of the store. example: 1a2df69xxx title: Store ID type: string title: List type: object report_summary: description: A summary of opens and clicks for sent campaigns. properties: click_rate: description: The number of unique clicks, divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object settings: description: The settings for the Automation workflow. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`. title: Authentication type: boolean auto_footer: description: Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation. title: Auto-Footer type: boolean from_name: description: The 'from' name for the Automation (not an email address). title: From Name type: string inline_css: description: Whether to automatically inline the CSS included with the Automation content. title: Inline CSS type: boolean reply_to: description: The reply-to email address for the Automation. title: Reply To Address type: string title: description: The title of the Automation. title: Automation Title type: string to_name: description: The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Whether to use Mailchimp Conversation feature to manage replies title: Conversations type: boolean title: Automation Campaign Settings type: object start_time: description: The date and time the Automation was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the Automation. enum: - save - paused - sending readOnly: true title: Automation Status type: string tracking: description: The tracking options for the Automation. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`. title: Plain-Text Click Tracking type: boolean title: Automation Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object title: Automation Workflow type: object application/problem+json: schema: description: A summary of an individual Automation workflow's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array create_time: description: The date and time the Automation was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string emails_sent: description: The total number of emails sent for the Automation. readOnly: true title: Emails Sent type: integer id: description: A string that identifies the Automation. readOnly: true title: Automation Campaign ID type: string recipients: description: List settings for the Automation. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: List Name. title: List Name type: string segment_opts: description: An object representing all segmentation options. properties: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object store_id: description: The id of the store. example: 1a2df69xxx title: Store ID type: string title: List type: object report_summary: description: A summary of opens and clicks for sent campaigns. properties: click_rate: description: The number of unique clicks, divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object settings: description: The settings for the Automation workflow. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`. title: Authentication type: boolean auto_footer: description: Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation. title: Auto-Footer type: boolean from_name: description: The 'from' name for the Automation (not an email address). title: From Name type: string inline_css: description: Whether to automatically inline the CSS included with the Automation content. title: Inline CSS type: boolean reply_to: description: The reply-to email address for the Automation. title: Reply To Address type: string title: description: The title of the Automation. title: Automation Title type: string to_name: description: The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Whether to use Mailchimp Conversation feature to manage replies title: Conversations type: boolean title: Automation Campaign Settings type: object start_time: description: The date and time the Automation was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the Automation. enum: - save - paused - sending readOnly: true title: Automation Status type: string tracking: description: The tracking options for the Automation. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`. title: Plain-Text Click Tracking type: boolean title: Automation Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object title: Automation Workflow type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add automation tags: - automations x-custom-config: methodNameCamel: create methodNameSnake: create "/automations/{workflow_id}": get: description: Get a summary of an individual classic automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow. operationId: getAutomationsId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string responses: "200": content: application/json: schema: description: A summary of an individual Automation workflow's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array create_time: description: The date and time the Automation was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string emails_sent: description: The total number of emails sent for the Automation. readOnly: true title: Emails Sent type: integer id: description: A string that identifies the Automation. readOnly: true title: Automation Campaign ID type: string recipients: description: List settings for the Automation. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: List Name. title: List Name type: string segment_opts: description: An object representing all segmentation options. properties: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object store_id: description: The id of the store. example: 1a2df69xxx title: Store ID type: string title: List type: object report_summary: description: A summary of opens and clicks for sent campaigns. properties: click_rate: description: The number of unique clicks, divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object settings: description: The settings for the Automation workflow. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`. title: Authentication type: boolean auto_footer: description: Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation. title: Auto-Footer type: boolean from_name: description: The 'from' name for the Automation (not an email address). title: From Name type: string inline_css: description: Whether to automatically inline the CSS included with the Automation content. title: Inline CSS type: boolean reply_to: description: The reply-to email address for the Automation. title: Reply To Address type: string title: description: The title of the Automation. title: Automation Title type: string to_name: description: The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Whether to use Mailchimp Conversation feature to manage replies title: Conversations type: boolean title: Automation Campaign Settings type: object start_time: description: The date and time the Automation was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the Automation. enum: - save - paused - sending readOnly: true title: Automation Status type: string tracking: description: The tracking options for the Automation. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`. title: Plain-Text Click Tracking type: boolean title: Automation Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object title: Automation Workflow type: object application/problem+json: schema: description: A summary of an individual Automation workflow's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array create_time: description: The date and time the Automation was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string emails_sent: description: The total number of emails sent for the Automation. readOnly: true title: Emails Sent type: integer id: description: A string that identifies the Automation. readOnly: true title: Automation Campaign ID type: string recipients: description: List settings for the Automation. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: List Name. title: List Name type: string segment_opts: description: An object representing all segmentation options. properties: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object store_id: description: The id of the store. example: 1a2df69xxx title: Store ID type: string title: List type: object report_summary: description: A summary of opens and clicks for sent campaigns. properties: click_rate: description: The number of unique clicks, divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object settings: description: The settings for the Automation workflow. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`. title: Authentication type: boolean auto_footer: description: Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation. title: Auto-Footer type: boolean from_name: description: The 'from' name for the Automation (not an email address). title: From Name type: string inline_css: description: Whether to automatically inline the CSS included with the Automation content. title: Inline CSS type: boolean reply_to: description: The reply-to email address for the Automation. title: Reply To Address type: string title: description: The title of the Automation. title: Automation Title type: string to_name: description: The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Whether to use Mailchimp Conversation feature to manage replies title: Conversations type: boolean title: Automation Campaign Settings type: object start_time: description: The date and time the Automation was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the Automation. enum: - save - paused - sending readOnly: true title: Automation Status type: string tracking: description: The tracking options for the Automation. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`. title: Plain-Text Click Tracking type: boolean title: Automation Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object title: Automation Workflow type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get automation info tags: - automations x-custom-config: methodNameCamel: get methodNameSnake: get "/automations/{workflow_id}/actions/archive": post: deprecated: false description: Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it. operationId: archiveAutomations parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Archive automation tags: - automations x-custom-config: methodNameCamel: archive methodNameSnake: archive "/automations/{workflow_id}/actions/pause-all-emails": post: deprecated: false description: Pause all emails in a specific classic automation workflow. operationId: postAutomationsIdActionsPauseAllEmails parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Pause automation emails tags: - automations x-custom-config: methodNameCamel: pauseAllEmails methodNameSnake: pause_all_emails "/automations/{workflow_id}/actions/start-all-emails": post: deprecated: false description: Start all emails in a classic automation workflow. operationId: postAutomationsIdActionsStartAllEmails parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Start automation emails tags: - automations x-custom-config: methodNameCamel: startAllEmails methodNameSnake: start_all_emails "/automations/{workflow_id}/emails": get: deprecated: false description: Get a summary of the emails in a classic automation workflow. operationId: getAutomationsIdEmails parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string responses: "200": content: application/json: schema: description: A summary of the emails in an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array emails: description: An array of objects, each representing an email in an Automation workflow. items: description: A summary of an individual Automation workflow email. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delay: description: The delay settings for an Automation email. properties: action: description: The action that triggers the delay of an Automation email. enum: - previous_campaign_sent - previous_campaign_opened - previous_campaign_not_opened - previous_campaign_clicked_any - previous_campaign_not_clicked_any - previous_campaign_specific_clicked - ecomm_bought_any - ecomm_bought_product - ecomm_bought_category - ecomm_not_bought_any - ecomm_abandoned_cart - campaign_sent - opened_email - not_opened_email - clicked_email - not_clicked_email - campaign_specific_clicked - manual - signup - merge_changed - group_add - group_remove - mandrill_sent - mandrill_opened - mandrill_clicked - mandrill_any - api - goal - annual - birthday - date - date_added - tag_add title: Delay Action type: string action_description: description: The user-friendly description of the action that triggers an Automation email. example: subscribers purchase anything from your store readOnly: true title: Delay Action Description type: string amount: description: The delay amount for an Automation email. readOnly: true title: Delay Amount type: integer direction: description: Whether the delay settings describe before or after the delay action of an Automation email. enum: - before - after title: Delay Direction type: string full_description: description: The user-friendly description of the delay and trigger action settings for an Automation email. example: 1 day after subscribers purchase anything from your store readOnly: true title: Full Delay Description type: string type: description: The type of delay for an Automation email. enum: - now - day - hour - week title: Delay Type type: string title: Automation Delay type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer has_logo_merge_tag: description: Determines if the campaign contains the *|BRAND:LOGO|* merge tag. example: true readOnly: true title: Has Logo Merge Tag type: boolean id: description: A string that uniquely identifies the Automation email. readOnly: true title: Automation Email ID type: string needs_block_refresh: description: Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor. example: true readOnly: true title: Needs Block Refresh type: boolean position: description: The position of an Automation email in a workflow. readOnly: true title: Email Position type: integer recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object send_time: description: " The date and time a campaign was sent in ISO 8601 format" format: date-time readOnly: true title: Send Time type: string settings: description: Settings for the campaign including the email subject, from name, and from email address. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. title: Template ID type: integer title: description: The title of the campaign. title: Campaign Title type: string title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object start_time: description: The date and time the campaign was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the campaign. enum: - save - paused - sending readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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`. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object web_id: description: The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. example: 33345484 readOnly: true title: Automation Web ID type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Automation Workflow Email type: object title: Emails type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Automation Emails type: object application/problem+json: schema: description: A summary of the emails in an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array emails: description: An array of objects, each representing an email in an Automation workflow. items: description: A summary of an individual Automation workflow email. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delay: description: The delay settings for an Automation email. properties: action: description: The action that triggers the delay of an Automation email. enum: - previous_campaign_sent - previous_campaign_opened - previous_campaign_not_opened - previous_campaign_clicked_any - previous_campaign_not_clicked_any - previous_campaign_specific_clicked - ecomm_bought_any - ecomm_bought_product - ecomm_bought_category - ecomm_not_bought_any - ecomm_abandoned_cart - campaign_sent - opened_email - not_opened_email - clicked_email - not_clicked_email - campaign_specific_clicked - manual - signup - merge_changed - group_add - group_remove - mandrill_sent - mandrill_opened - mandrill_clicked - mandrill_any - api - goal - annual - birthday - date - date_added - tag_add title: Delay Action type: string action_description: description: The user-friendly description of the action that triggers an Automation email. example: subscribers purchase anything from your store readOnly: true title: Delay Action Description type: string amount: description: The delay amount for an Automation email. readOnly: true title: Delay Amount type: integer direction: description: Whether the delay settings describe before or after the delay action of an Automation email. enum: - before - after title: Delay Direction type: string full_description: description: The user-friendly description of the delay and trigger action settings for an Automation email. example: 1 day after subscribers purchase anything from your store readOnly: true title: Full Delay Description type: string type: description: The type of delay for an Automation email. enum: - now - day - hour - week title: Delay Type type: string title: Automation Delay type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer has_logo_merge_tag: description: Determines if the campaign contains the *|BRAND:LOGO|* merge tag. example: true readOnly: true title: Has Logo Merge Tag type: boolean id: description: A string that uniquely identifies the Automation email. readOnly: true title: Automation Email ID type: string needs_block_refresh: description: Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor. example: true readOnly: true title: Needs Block Refresh type: boolean position: description: The position of an Automation email in a workflow. readOnly: true title: Email Position type: integer recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object send_time: description: " The date and time a campaign was sent in ISO 8601 format" format: date-time readOnly: true title: Send Time type: string settings: description: Settings for the campaign including the email subject, from name, and from email address. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. title: Template ID type: integer title: description: The title of the campaign. title: Campaign Title type: string title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object start_time: description: The date and time the campaign was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the campaign. enum: - save - paused - sending readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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`. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object web_id: description: The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. example: 33345484 readOnly: true title: Automation Web ID type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Automation Workflow Email type: object title: Emails type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Automation Emails type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List automated emails tags: - automations x-custom-config: methodNameCamel: listAllWorkflowEmails methodNameSnake: list_all_workflow_emails "/automations/{workflow_id}/emails/{workflow_email_id}": delete: deprecated: false description: Removes an individual classic automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted. operationId: deleteAutomationsIdEmailsId parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The unique id for the Automation workflow email. in: path name: workflow_email_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete workflow email tags: - automations x-custom-config: methodNameCamel: deleteWorkflowEmail methodNameSnake: delete_workflow_email get: deprecated: false description: Get information about an individual classic automation workflow email. operationId: getAutomationsIdEmailsId parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The unique id for the Automation workflow email. in: path name: workflow_email_id required: true schema: type: string responses: "200": content: application/json: schema: description: A summary of an individual Automation workflow email. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delay: description: The delay settings for an Automation email. properties: action: description: The action that triggers the delay of an Automation email. enum: - previous_campaign_sent - previous_campaign_opened - previous_campaign_not_opened - previous_campaign_clicked_any - previous_campaign_not_clicked_any - previous_campaign_specific_clicked - ecomm_bought_any - ecomm_bought_product - ecomm_bought_category - ecomm_not_bought_any - ecomm_abandoned_cart - campaign_sent - opened_email - not_opened_email - clicked_email - not_clicked_email - campaign_specific_clicked - manual - signup - merge_changed - group_add - group_remove - mandrill_sent - mandrill_opened - mandrill_clicked - mandrill_any - api - goal - annual - birthday - date - date_added - tag_add title: Delay Action type: string action_description: description: The user-friendly description of the action that triggers an Automation email. example: subscribers purchase anything from your store readOnly: true title: Delay Action Description type: string amount: description: The delay amount for an Automation email. readOnly: true title: Delay Amount type: integer direction: description: Whether the delay settings describe before or after the delay action of an Automation email. enum: - before - after title: Delay Direction type: string full_description: description: The user-friendly description of the delay and trigger action settings for an Automation email. example: 1 day after subscribers purchase anything from your store readOnly: true title: Full Delay Description type: string type: description: The type of delay for an Automation email. enum: - now - day - hour - week title: Delay Type type: string title: Automation Delay type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer has_logo_merge_tag: description: Determines if the campaign contains the *|BRAND:LOGO|* merge tag. example: true readOnly: true title: Has Logo Merge Tag type: boolean id: description: A string that uniquely identifies the Automation email. readOnly: true title: Automation Email ID type: string needs_block_refresh: description: Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor. example: true readOnly: true title: Needs Block Refresh type: boolean position: description: The position of an Automation email in a workflow. readOnly: true title: Email Position type: integer recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object send_time: description: " The date and time a campaign was sent in ISO 8601 format" format: date-time readOnly: true title: Send Time type: string settings: description: Settings for the campaign including the email subject, from name, and from email address. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. title: Template ID type: integer title: description: The title of the campaign. title: Campaign Title type: string title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object start_time: description: The date and time the campaign was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the campaign. enum: - save - paused - sending readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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`. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object web_id: description: The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. example: 33345484 readOnly: true title: Automation Web ID type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Automation Workflow Email type: object application/problem+json: schema: description: A summary of an individual Automation workflow email. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delay: description: The delay settings for an Automation email. properties: action: description: The action that triggers the delay of an Automation email. enum: - previous_campaign_sent - previous_campaign_opened - previous_campaign_not_opened - previous_campaign_clicked_any - previous_campaign_not_clicked_any - previous_campaign_specific_clicked - ecomm_bought_any - ecomm_bought_product - ecomm_bought_category - ecomm_not_bought_any - ecomm_abandoned_cart - campaign_sent - opened_email - not_opened_email - clicked_email - not_clicked_email - campaign_specific_clicked - manual - signup - merge_changed - group_add - group_remove - mandrill_sent - mandrill_opened - mandrill_clicked - mandrill_any - api - goal - annual - birthday - date - date_added - tag_add title: Delay Action type: string action_description: description: The user-friendly description of the action that triggers an Automation email. example: subscribers purchase anything from your store readOnly: true title: Delay Action Description type: string amount: description: The delay amount for an Automation email. readOnly: true title: Delay Amount type: integer direction: description: Whether the delay settings describe before or after the delay action of an Automation email. enum: - before - after title: Delay Direction type: string full_description: description: The user-friendly description of the delay and trigger action settings for an Automation email. example: 1 day after subscribers purchase anything from your store readOnly: true title: Full Delay Description type: string type: description: The type of delay for an Automation email. enum: - now - day - hour - week title: Delay Type type: string title: Automation Delay type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer has_logo_merge_tag: description: Determines if the campaign contains the *|BRAND:LOGO|* merge tag. example: true readOnly: true title: Has Logo Merge Tag type: boolean id: description: A string that uniquely identifies the Automation email. readOnly: true title: Automation Email ID type: string needs_block_refresh: description: Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor. example: true readOnly: true title: Needs Block Refresh type: boolean position: description: The position of an Automation email in a workflow. readOnly: true title: Email Position type: integer recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object send_time: description: " The date and time a campaign was sent in ISO 8601 format" format: date-time readOnly: true title: Send Time type: string settings: description: Settings for the campaign including the email subject, from name, and from email address. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. title: Template ID type: integer title: description: The title of the campaign. title: Campaign Title type: string title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object start_time: description: The date and time the campaign was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the campaign. enum: - save - paused - sending readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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`. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object web_id: description: The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. example: 33345484 readOnly: true title: Automation Web ID type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Automation Workflow Email type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get workflow email info tags: - automations x-custom-config: methodNameCamel: getWorkflowEmail methodNameSnake: get_workflow_email patch: description: "Update settings for a classic automation workflow email. Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome." operationId: patchAutomationEmailWorkflowId parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The unique id for the Automation workflow email. in: path name: workflow_email_id required: true schema: type: string requestBody: content: application/json: schema: description: Update information about an individual Automation workflow email. properties: delay: description: The delay settings for an automation email. properties: action: description: The action that triggers the delay of an automation emails. enum: - signup - ecomm_abandoned_browse - ecomm_abandoned_cart example: signup title: Delay Action type: string amount: description: The delay amount for an automation email. example: 1 title: Delay Amount type: integer direction: description: Whether the delay settings describe before or after the delay action of an automation email. enum: - after example: after title: Delay Direction type: string type: description: The type of delay for an automation email. enum: - now - day - hour - week example: day title: Delay Type type: string required: - action title: Automation Delay type: object settings: description: Settings for the campaign including the email subject, from name, and from email address. properties: from_name: description: The 'from' name for the Automation (not an email address). title: From Name type: string preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the Automation. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string title: description: The title of the Automation. title: Automation Title type: string title: Campaign Settings type: object title: Update information about a specific workflow email type: object required: true responses: "200": content: application/json: schema: description: A summary of an individual Automation workflow email. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delay: description: The delay settings for an Automation email. properties: action: description: The action that triggers the delay of an Automation email. enum: - previous_campaign_sent - previous_campaign_opened - previous_campaign_not_opened - previous_campaign_clicked_any - previous_campaign_not_clicked_any - previous_campaign_specific_clicked - ecomm_bought_any - ecomm_bought_product - ecomm_bought_category - ecomm_not_bought_any - ecomm_abandoned_cart - campaign_sent - opened_email - not_opened_email - clicked_email - not_clicked_email - campaign_specific_clicked - manual - signup - merge_changed - group_add - group_remove - mandrill_sent - mandrill_opened - mandrill_clicked - mandrill_any - api - goal - annual - birthday - date - date_added - tag_add title: Delay Action type: string action_description: description: The user-friendly description of the action that triggers an Automation email. example: subscribers purchase anything from your store readOnly: true title: Delay Action Description type: string amount: description: The delay amount for an Automation email. readOnly: true title: Delay Amount type: integer direction: description: Whether the delay settings describe before or after the delay action of an Automation email. enum: - before - after title: Delay Direction type: string full_description: description: The user-friendly description of the delay and trigger action settings for an Automation email. example: 1 day after subscribers purchase anything from your store readOnly: true title: Full Delay Description type: string type: description: The type of delay for an Automation email. enum: - now - day - hour - week title: Delay Type type: string title: Automation Delay type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer has_logo_merge_tag: description: Determines if the campaign contains the *|BRAND:LOGO|* merge tag. example: true readOnly: true title: Has Logo Merge Tag type: boolean id: description: A string that uniquely identifies the Automation email. readOnly: true title: Automation Email ID type: string needs_block_refresh: description: Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor. example: true readOnly: true title: Needs Block Refresh type: boolean position: description: The position of an Automation email in a workflow. readOnly: true title: Email Position type: integer recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object send_time: description: " The date and time a campaign was sent in ISO 8601 format" format: date-time readOnly: true title: Send Time type: string settings: description: Settings for the campaign including the email subject, from name, and from email address. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. title: Template ID type: integer title: description: The title of the campaign. title: Campaign Title type: string title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object start_time: description: The date and time the campaign was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the campaign. enum: - save - paused - sending readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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`. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object web_id: description: The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. example: 33345484 readOnly: true title: Automation Web ID type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Automation Workflow Email type: object application/problem+json: schema: description: A summary of an individual Automation workflow email. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delay: description: The delay settings for an Automation email. properties: action: description: The action that triggers the delay of an Automation email. enum: - previous_campaign_sent - previous_campaign_opened - previous_campaign_not_opened - previous_campaign_clicked_any - previous_campaign_not_clicked_any - previous_campaign_specific_clicked - ecomm_bought_any - ecomm_bought_product - ecomm_bought_category - ecomm_not_bought_any - ecomm_abandoned_cart - campaign_sent - opened_email - not_opened_email - clicked_email - not_clicked_email - campaign_specific_clicked - manual - signup - merge_changed - group_add - group_remove - mandrill_sent - mandrill_opened - mandrill_clicked - mandrill_any - api - goal - annual - birthday - date - date_added - tag_add title: Delay Action type: string action_description: description: The user-friendly description of the action that triggers an Automation email. example: subscribers purchase anything from your store readOnly: true title: Delay Action Description type: string amount: description: The delay amount for an Automation email. readOnly: true title: Delay Amount type: integer direction: description: Whether the delay settings describe before or after the delay action of an Automation email. enum: - before - after title: Delay Direction type: string full_description: description: The user-friendly description of the delay and trigger action settings for an Automation email. example: 1 day after subscribers purchase anything from your store readOnly: true title: Full Delay Description type: string type: description: The type of delay for an Automation email. enum: - now - day - hour - week title: Delay Type type: string title: Automation Delay type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer has_logo_merge_tag: description: Determines if the campaign contains the *|BRAND:LOGO|* merge tag. example: true readOnly: true title: Has Logo Merge Tag type: boolean id: description: A string that uniquely identifies the Automation email. readOnly: true title: Automation Email ID type: string needs_block_refresh: description: Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor. example: true readOnly: true title: Needs Block Refresh type: boolean position: description: The position of an Automation email in a workflow. readOnly: true title: Email Position type: integer recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object send_time: description: " The date and time a campaign was sent in ISO 8601 format" format: date-time readOnly: true title: Send Time type: string settings: description: Settings for the campaign including the email subject, from name, and from email address. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. title: Template ID type: integer title: description: The title of the campaign. title: Campaign Title type: string title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object start_time: description: The date and time the campaign was started in ISO 8601 format. format: date-time readOnly: true title: Start Time type: string status: description: The current status of the campaign. enum: - save - paused - sending readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: description: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on a subscriber's email address. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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`. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object trigger_settings: description: Available triggers for Automation workflows. discriminator: propertyName: workflow_type properties: runtime: description: A workflow's runtime settings for an Automation. properties: days: description: The days an Automation workflow can send. items: enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday type: string title: Days type: array hours: description: The hours an Automation workflow can send. properties: type: description: When to send the Automation email. enum: - send_asap - send_between - send_at title: Email Send Time Settings type: string required: - type title: Hours type: object title: Automation Workflow Runtime Settings type: object workflow_emails_count: description: The number of emails in the Automation workflow. readOnly: true title: Workflow Emails Count type: integer workflow_title: description: The title of the workflow type. readOnly: true title: Workflow Title type: string workflow_type: description: The type of Automation workflow. enum: - abandonedBrowse - abandonedCart - api - bestCustomers - categoryFollowup - dateAdded - emailFollowup - emailSeries - groupAdd - groupRemove - mandrill - productFollowup - purchaseFollowup - recurringEvent - specialEvent - visitUrl - welcomeSeries title: Workflow Type type: string required: - workflow_type title: Automation Trigger type: object web_id: description: The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. example: 33345484 readOnly: true title: Automation Web ID type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Automation Workflow Email type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update workflow email tags: - automations x-custom-config: methodNameCamel: updateWorkflowEmail methodNameSnake: update_workflow_email "/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause": post: deprecated: false description: Pause an automated email. operationId: postAutomationsIdEmailsIdActionsPause parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The unique id for the Automation workflow email. in: path name: workflow_email_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Pause automated email tags: - automations x-custom-config: methodNameCamel: pauseWorkflowEmail methodNameSnake: pause_workflow_email "/automations/{workflow_id}/emails/{workflow_email_id}/actions/start": post: deprecated: false description: Start an automated email. operationId: postAutomationsIdEmailsIdActionsStart parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The unique id for the Automation workflow email. in: path name: workflow_email_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Start automated email tags: - automations x-custom-config: methodNameCamel: startWorkflowEmail methodNameSnake: start_workflow_email "/automations/{workflow_id}/emails/{workflow_email_id}/queue": get: deprecated: false description: Get information about a classic automation email queue. operationId: getAutomationsIdEmailsIdQueue parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The unique id for the Automation workflow email. in: path name: workflow_email_id required: true schema: type: string responses: "200": content: application/json: schema: description: An automation workflow properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_id: description: A string that uniquely identifies an email in an Automation workflow. readOnly: true title: Automation Email ID type: string queue: description: An array of objects, each representing a subscriber queue for an email in an Automation workflow. items: description: Information about subscribers in an Automation email queue. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string email_id: description: A string that uniquely identifies an email in an Automation workflow. readOnly: true title: Automation Email ID type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string next_send: description: The date and time of the next send for the workflow email in ISO 8601 format. format: date-time readOnly: true title: Next Send type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string required: - email_address title: Subscriber in Automation Queue type: object readOnly: true title: Trigger type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string type: object application/problem+json: schema: description: An automation workflow properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_id: description: A string that uniquely identifies an email in an Automation workflow. readOnly: true title: Automation Email ID type: string queue: description: An array of objects, each representing a subscriber queue for an email in an Automation workflow. items: description: Information about subscribers in an Automation email queue. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string email_id: description: A string that uniquely identifies an email in an Automation workflow. readOnly: true title: Automation Email ID type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string next_send: description: The date and time of the next send for the workflow email in ISO 8601 format. format: date-time readOnly: true title: Next Send type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string required: - email_address title: Subscriber in Automation Queue type: object readOnly: true title: Trigger type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List automated email subscribers tags: - automations x-custom-config: methodNameCamel: getWorkflowEmailSubscriberQueue methodNameSnake: get_workflow_email_subscriber_queue post: deprecated: false description: Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type. operationId: postAutomationsIdEmailsIdQueue parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The unique id for the Automation workflow email. in: path name: workflow_email_id required: true schema: type: string requestBody: $ref: "#/components/requestBodies/postAutomationsIdEmailsIdQueueBody" responses: "200": content: application/json: schema: description: Information about subscribers in an Automation email queue. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string email_id: description: A string that uniquely identifies an email in an Automation workflow. readOnly: true title: Automation Email ID type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean next_send: description: The date and time of the next send for the workflow email in ISO 8601 format. format: date-time readOnly: true title: Next Send type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber in Automation Queue type: object application/problem+json: schema: description: Information about subscribers in an Automation email queue. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string email_id: description: A string that uniquely identifies an email in an Automation workflow. readOnly: true title: Automation Email ID type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean next_send: description: The date and time of the next send for the workflow email in ISO 8601 format. format: date-time readOnly: true title: Next Send type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber in Automation Queue type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add subscriber to workflow email tags: - automations x-custom-config: methodNameCamel: addWorkflowEmailSubscriber methodNameSnake: add_workflow_email_subscriber "/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}": get: deprecated: false description: Get information about a specific subscriber in a classic automation email queue. operationId: getAutomationsIdEmailsIdQueueId parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The unique id for the Automation workflow email. in: path name: workflow_email_id required: true schema: type: string - description: The MD5 hash of the lowercase version of the list member's email address. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash responses: "200": content: application/json: schema: description: Information about subscribers in an Automation email queue. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string email_id: description: A string that uniquely identifies an email in an Automation workflow. readOnly: true title: Automation Email ID type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean next_send: description: The date and time of the next send for the workflow email in ISO 8601 format. format: date-time readOnly: true title: Next Send type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber in Automation Queue type: object application/problem+json: schema: description: Information about subscribers in an Automation email queue. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string email_id: description: A string that uniquely identifies an email in an Automation workflow. readOnly: true title: Automation Email ID type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean next_send: description: The date and time of the next send for the workflow email in ISO 8601 format. format: date-time readOnly: true title: Next Send type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber in Automation Queue type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get automated email subscriber tags: - automations x-custom-config: methodNameCamel: getWorkflowEmailSubscriber methodNameSnake: get_workflow_email_subscriber "/automations/{workflow_id}/removed-subscribers": get: deprecated: false description: Get information about subscribers who were removed from a classic automation workflow. operationId: getAutomationsIdRemovedSubscribers parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string responses: "200": content: application/json: schema: description: A summary of the subscribers who were removed from an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array subscribers: description: An array of objects, each representing a subscriber who was removed from an Automation workflow. items: description: A summary of a subscriber removed from an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber Removed from Automation Workflow type: object readOnly: true title: Trigger type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Removed Subscribers type: object application/problem+json: schema: description: A summary of the subscribers who were removed from an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array subscribers: description: An array of objects, each representing a subscriber who was removed from an Automation workflow. items: description: A summary of a subscriber removed from an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber Removed from Automation Workflow type: object readOnly: true title: Trigger type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Removed Subscribers type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List subscribers removed from workflow tags: - automations x-custom-config: methodNameCamel: listWorkflowEmailSubscribersRemoved methodNameSnake: list_workflow_email_subscribers_removed post: deprecated: false description: Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow. operationId: postAutomationsIdRemovedSubscribers parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string requestBody: $ref: "#/components/requestBodies/postAutomationsIdEmailsIdQueueBody" responses: "200": content: application/json: schema: description: A summary of a subscriber removed from an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber Removed from Automation Workflow type: object application/problem+json: schema: description: A summary of a subscriber removed from an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber Removed from Automation Workflow type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Remove subscriber from workflow tags: - automations x-custom-config: methodNameCamel: removeWorkflowEmailSubscriber methodNameSnake: remove_workflow_email_subscriber "/automations/{workflow_id}/removed-subscribers/{subscriber_hash}": get: deprecated: false description: Get information about a specific subscriber who was removed from a classic automation workflow. operationId: getAutomationsIdRemovedSubscribersId parameters: - description: The unique id for the Automation workflow. in: path name: workflow_id required: true schema: type: string - description: The MD5 hash of the lowercase version of the list member's email address. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash responses: "200": content: application/json: schema: description: A summary of a subscriber removed from an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber Removed from Automation Workflow type: object application/problem+json: schema: description: A summary of a subscriber removed from an Automation workflow. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array email_address: description: The list member's email address. title: Email Address type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: A string that uniquely identifies a list. readOnly: true title: List ID type: string workflow_id: description: A string that uniquely identifies an Automation workflow. readOnly: true title: Workflow ID type: string title: Subscriber Removed from Automation Workflow type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get subscriber removed from workflow tags: - automations x-custom-config: methodNameCamel: getRemovedWorkflowEmailSubscriber methodNameSnake: get_removed_workflow_email_subscriber /batch-webhooks: get: deprecated: false description: Get all webhooks that have been configured for batches. operationId: getBatchWebhooks parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset responses: "200": content: application/json: schema: description: Manage webhooks for batch requests. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer webhooks: description: An array of objects, each representing a Batch Webhook. items: description: A webhook configured for batch status updates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array enabled: description: Whether the webhook receives requests or not. example: true readOnly: false title: Enabled type: boolean id: description: A string that uniquely identifies this Batch Webhook. readOnly: true title: Batch Webhook ID type: string url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: false title: URL type: string title: Batch Webhook type: object title: Webhooks type: array title: Batch Webhooks type: object application/problem+json: schema: description: Manage webhooks for batch requests. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer webhooks: description: An array of objects, each representing a Batch Webhook. items: description: A webhook configured for batch status updates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array enabled: description: Whether the webhook receives requests or not. example: true readOnly: false title: Enabled type: boolean id: description: A string that uniquely identifies this Batch Webhook. readOnly: true title: Batch Webhook ID type: string url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: false title: URL type: string title: Batch Webhook type: object title: Webhooks type: array title: Batch Webhooks type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List batch webhooks tags: - batchWebhooks x-custom-config: methodNameCamel: list methodNameSnake: list post: deprecated: false description: Configure a webhook that will fire whenever any batch request completes processing. You may only have a maximum of 20 batch webhooks. operationId: postBatchWebhooks requestBody: content: application/json: schema: description: Add a new Batch Webook. properties: enabled: description: Whether the webhook receives requests or not. example: true title: Enabled type: boolean url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook title: URL type: string required: - url title: Batch Webhook type: object required: true responses: "200": content: application/json: schema: description: A webhook configured for batch status updates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array enabled: description: Whether the webhook receives requests or not. example: true readOnly: false title: Enabled type: boolean id: description: A string that uniquely identifies this Batch Webhook. readOnly: true title: Batch Webhook ID type: string url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: false title: URL type: string title: Batch Webhook type: object application/problem+json: schema: description: A webhook configured for batch status updates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array enabled: description: Whether the webhook receives requests or not. example: true readOnly: false title: Enabled type: boolean id: description: A string that uniquely identifies this Batch Webhook. readOnly: true title: Batch Webhook ID type: string url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: false title: URL type: string title: Batch Webhook type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add batch webhook tags: - batchWebhooks x-custom-config: methodNameCamel: create methodNameSnake: create "/batch-webhooks/{batch_webhook_id}": delete: deprecated: false description: Remove a batch webhook. Webhooks will no longer be sent to the given URL. operationId: deleteBatchWebhookId parameters: - description: The unique id for the batch webhook. in: path name: batch_webhook_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete batch webhook tags: - batchWebhooks x-custom-config: methodNameCamel: remove methodNameSnake: remove get: deprecated: false description: Get information about a specific batch webhook. operationId: getBatchWebhook parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the batch webhook. in: path name: batch_webhook_id required: true schema: type: string responses: "200": content: application/json: schema: description: A webhook configured for batch status updates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array enabled: description: Whether the webhook receives requests or not. example: true readOnly: false title: Enabled type: boolean id: description: A string that uniquely identifies this Batch Webhook. readOnly: true title: Batch Webhook ID type: string url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: false title: URL type: string title: Batch Webhook type: object application/problem+json: schema: description: A webhook configured for batch status updates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array enabled: description: Whether the webhook receives requests or not. example: true readOnly: false title: Enabled type: boolean id: description: A string that uniquely identifies this Batch Webhook. readOnly: true title: Batch Webhook ID type: string url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: false title: URL type: string title: Batch Webhook type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get batch webhook info tags: - batchWebhooks x-custom-config: methodNameCamel: get methodNameSnake: get patch: deprecated: false description: Update a webhook that will fire whenever any batch request completes processing. operationId: patchBatchWebhooks parameters: - description: The unique id for the batch webhook. in: path name: batch_webhook_id required: true schema: type: string requestBody: content: application/json: schema: description: Update an existing Batch Webook. properties: enabled: description: Whether the webhook receives requests or not. example: true title: Enabled type: boolean url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook title: URL type: string title: Batch Webhook type: object required: true responses: "200": content: application/json: schema: description: A webhook configured for batch status updates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array enabled: description: Whether the webhook receives requests or not. example: true readOnly: false title: Enabled type: boolean id: description: A string that uniquely identifies this Batch Webhook. readOnly: true title: Batch Webhook ID type: string url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: false title: URL type: string title: Batch Webhook type: object application/problem+json: schema: description: A webhook configured for batch status updates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array enabled: description: Whether the webhook receives requests or not. example: true readOnly: false title: Enabled type: boolean id: description: A string that uniquely identifies this Batch Webhook. readOnly: true title: Batch Webhook ID type: string url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: false title: URL type: string title: Batch Webhook type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update batch webhook tags: - batchWebhooks x-custom-config: methodNameCamel: update methodNameSnake: update /batches: get: deprecated: false description: Get a summary of batch requests that have been made. operationId: getBatches parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset responses: "200": content: application/json: schema: description: A summary of batch requests that have been made. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array batches: description: An array of objects representing batch calls. items: description: The status of a batch request properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array completed_at: description: The date and time when all operations in the batch request completed in ISO 8601 format. format: date-time readOnly: true title: Completed At type: string errored_operations: description: The number of completed operations that returned an error. readOnly: true title: Error Operations type: integer finished_operations: description: The number of completed operations. This includes operations that returned an error. readOnly: true title: Finished Operations type: integer id: description: A string that uniquely identifies this batch request. readOnly: true title: Batch ID type: string response_body_url: description: The URL of the gzipped archive of the results of all the operations. readOnly: true title: Response Body URL type: string status: description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true title: Status type: string submitted_at: description: The date and time when the server received the batch request in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string total_operations: description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true title: Total Operations type: integer title: Batch type: object title: Batches type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Batch Operations type: object application/problem+json: schema: description: A summary of batch requests that have been made. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array batches: description: An array of objects representing batch calls. items: description: The status of a batch request properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array completed_at: description: The date and time when all operations in the batch request completed in ISO 8601 format. format: date-time readOnly: true title: Completed At type: string errored_operations: description: The number of completed operations that returned an error. readOnly: true title: Error Operations type: integer finished_operations: description: The number of completed operations. This includes operations that returned an error. readOnly: true title: Finished Operations type: integer id: description: A string that uniquely identifies this batch request. readOnly: true title: Batch ID type: string response_body_url: description: The URL of the gzipped archive of the results of all the operations. readOnly: true title: Response Body URL type: string status: description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true title: Status type: string submitted_at: description: The date and time when the server received the batch request in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string total_operations: description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true title: Total Operations type: integer title: Batch type: object title: Batches type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Batch Operations type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List batch requests tags: - batches x-custom-config: methodNameCamel: list methodNameSnake: list post: deprecated: false description: Begin processing a batch operations request. operationId: postBatches requestBody: content: application/json: schema: properties: operations: description: An array of objects that describes operations to perform. items: properties: body: description: A string containing the JSON body to use with the request. example: '{"title":"Test"}' title: Body type: string method: description: The HTTP method to use for the operation. enum: - GET - POST - PUT - PATCH - DELETE example: POST title: HTTP Method type: string operation_id: description: An optional client-supplied id returned with the operation results. example: my-id-123 title: Operation ID type: string params: description: 'Any request query parameters. Example parameters: {"count":10, "offset":0}' example: '{"count":10,"offset":0}' title: Query Parameters type: object path: description: The relative path to use for the operation. example: /lists title: Path type: string required: - method - path title: Operations type: object title: Operations List type: array required: - operations type: object required: true responses: "200": content: application/json: schema: description: The status of a batch request properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array completed_at: description: The date and time when all operations in the batch request completed in ISO 8601 format. format: date-time readOnly: true title: Completed At type: string errored_operations: description: The number of completed operations that returned an error. readOnly: true title: Error Operations type: integer finished_operations: description: The number of completed operations. This includes operations that returned an error. readOnly: true title: Finished Operations type: integer id: description: A string that uniquely identifies this batch request. readOnly: true title: Batch ID type: string response_body_url: description: The URL of the gzipped archive of the results of all the operations. readOnly: true title: Response Body URL type: string status: description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true title: Status type: string submitted_at: description: The date and time when the server received the batch request in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string total_operations: description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true title: Total Operations type: integer title: Batch type: object application/problem+json: schema: description: The status of a batch request properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array completed_at: description: The date and time when all operations in the batch request completed in ISO 8601 format. format: date-time readOnly: true title: Completed At type: string errored_operations: description: The number of completed operations that returned an error. readOnly: true title: Error Operations type: integer finished_operations: description: The number of completed operations. This includes operations that returned an error. readOnly: true title: Finished Operations type: integer id: description: A string that uniquely identifies this batch request. readOnly: true title: Batch ID type: string response_body_url: description: The URL of the gzipped archive of the results of all the operations. readOnly: true title: Response Body URL type: string status: description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true title: Status type: string submitted_at: description: The date and time when the server received the batch request in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string total_operations: description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true title: Total Operations type: integer title: Batch type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Start batch operation tags: - batches x-custom-config: methodNameCamel: start methodNameSnake: start "/batches/{batch_id}": delete: deprecated: false description: Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call. operationId: deleteBatchesId parameters: - description: The unique id for the batch operation. in: path name: batch_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete batch request tags: - batches x-custom-config: methodNameCamel: deleteRequest methodNameSnake: delete_request get: deprecated: false description: Get the status of a batch request. operationId: getBatchesId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the batch operation. in: path name: batch_id required: true schema: type: string responses: "200": content: application/json: schema: description: The status of a batch request properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array completed_at: description: The date and time when all operations in the batch request completed in ISO 8601 format. format: date-time readOnly: true title: Completed At type: string errored_operations: description: The number of completed operations that returned an error. readOnly: true title: Error Operations type: integer finished_operations: description: The number of completed operations. This includes operations that returned an error. readOnly: true title: Finished Operations type: integer id: description: A string that uniquely identifies this batch request. readOnly: true title: Batch ID type: string response_body_url: description: The URL of the gzipped archive of the results of all the operations. readOnly: true title: Response Body URL type: string status: description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true title: Status type: string submitted_at: description: The date and time when the server received the batch request in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string total_operations: description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true title: Total Operations type: integer title: Batch type: object application/problem+json: schema: description: The status of a batch request properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array completed_at: description: The date and time when all operations in the batch request completed in ISO 8601 format. format: date-time readOnly: true title: Completed At type: string errored_operations: description: The number of completed operations that returned an error. readOnly: true title: Error Operations type: integer finished_operations: description: The number of completed operations. This includes operations that returned an error. readOnly: true title: Finished Operations type: integer id: description: A string that uniquely identifies this batch request. readOnly: true title: Batch ID type: string response_body_url: description: The URL of the gzipped archive of the results of all the operations. readOnly: true title: Response Body URL type: string status: description: The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true title: Status type: string submitted_at: description: The date and time when the server received the batch request in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string total_operations: description: The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true title: Total Operations type: integer title: Batch type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get batch operation status tags: - batches x-custom-config: methodNameCamel: status methodNameSnake: status /campaign-folders: get: deprecated: false description: Get all folders used to organize campaigns. operationId: getCampaignFolders parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset responses: "200": content: application/json: schema: description: A list of campaign folders properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array folders: description: An array of objects representing campaign folders. items: description: A folder used to organize campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array count: description: The number of campaigns in the folder. readOnly: true title: Campaign Count type: integer id: description: A string that uniquely identifies this campaign folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Campaign Folder type: object title: Campaign Folders type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Campaign Folders type: object application/problem+json: schema: description: A list of campaign folders properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array folders: description: An array of objects representing campaign folders. items: description: A folder used to organize campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array count: description: The number of campaigns in the folder. readOnly: true title: Campaign Count type: integer id: description: A string that uniquely identifies this campaign folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Campaign Folder type: object title: Campaign Folders type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Campaign Folders type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List campaign folders tags: - campaignFolders x-custom-config: methodNameCamel: list methodNameSnake: list post: deprecated: false description: Create a new campaign folder. operationId: postCampaignFolders requestBody: $ref: "#/components/requestBodies/postCampaignFoldersBody" responses: "200": content: application/json: schema: description: A folder used to organize campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array count: description: The number of campaigns in the folder. readOnly: true title: Campaign Count type: integer id: description: A string that uniquely identifies this campaign folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Campaign Folder type: object application/problem+json: schema: description: A folder used to organize campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array count: description: The number of campaigns in the folder. readOnly: true title: Campaign Count type: integer id: description: A string that uniquely identifies this campaign folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Campaign Folder type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add campaign folder tags: - campaignFolders x-custom-config: methodNameCamel: create methodNameSnake: create "/campaign-folders/{folder_id}": delete: deprecated: false description: Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'. operationId: deleteCampaignFoldersId parameters: - description: The unique id for the campaign folder. in: path name: folder_id required: true schema: type: string responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete campaign folder tags: - campaignFolders x-custom-config: methodNameCamel: remove methodNameSnake: remove get: deprecated: false description: Get information about a specific folder used to organize campaigns. operationId: getCampaignFoldersId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the campaign folder. in: path name: folder_id required: true schema: type: string responses: "200": content: application/json: schema: description: A folder used to organize campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array count: description: The number of campaigns in the folder. readOnly: true title: Campaign Count type: integer id: description: A string that uniquely identifies this campaign folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Campaign Folder type: object application/problem+json: schema: description: A folder used to organize campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array count: description: The number of campaigns in the folder. readOnly: true title: Campaign Count type: integer id: description: A string that uniquely identifies this campaign folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Campaign Folder type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get campaign folder tags: - campaignFolders x-custom-config: methodNameCamel: get methodNameSnake: get patch: deprecated: false description: Update a specific folder used to organize campaigns. operationId: patchCampaignFoldersId parameters: - description: The unique id for the campaign folder. in: path name: folder_id required: true schema: type: string requestBody: $ref: "#/components/requestBodies/postCampaignFoldersBody" responses: "200": content: application/json: schema: description: A folder used to organize campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array count: description: The number of campaigns in the folder. readOnly: true title: Campaign Count type: integer id: description: A string that uniquely identifies this campaign folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Campaign Folder type: object application/problem+json: schema: description: A folder used to organize campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array count: description: The number of campaigns in the folder. readOnly: true title: Campaign Count type: integer id: description: A string that uniquely identifies this campaign folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Campaign Folder type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update campaign folder tags: - campaignFolders x-custom-config: methodNameCamel: update methodNameSnake: update /campaigns: get: deprecated: false description: Get all campaigns in an account. operationId: getCampaigns parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The campaign type. in: query name: type required: false schema: enum: - regular - plaintext - absplit - rss - variate type: string x-title: Campaign Type - description: The status of the campaign. in: query name: status required: false schema: enum: - save - paused - schedule - sending - sent type: string x-title: Status - description: "Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_send_time required: false schema: format: date-time type: string x-title: Before Send Time - description: "Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_send_time required: false schema: format: date-time type: string x-title: Since Send Time - description: "Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_create_time required: false schema: format: date-time type: string x-title: Before Create Time - description: "Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_create_time required: false schema: format: date-time type: string x-title: Since Create Time - description: The unique id for the list. in: query name: list_id required: false schema: type: string x-title: List ID - description: The unique folder id. in: query name: folder_id required: false schema: type: string x-title: Folder ID - description: Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address. in: query name: member_id required: false schema: type: string x-title: Member ID - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - create_time - send_time type: string x-title: Sort By Field - description: Determines the order direction for sorted results. in: query name: sort_dir required: false schema: enum: - ASC - DESC type: string x-title: Sort Direction responses: "200": content: application/json: schema: description: An array of campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaigns: description: An array of campaigns. items: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together. enum: - template - html - url - multichannel title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens, clicks, and e-commerce data. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object title: RSS Options type: object send_time: description: The date and time a campaign was sent. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: false title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer title: Campaign type: object title: Campaigns type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object application/problem+json: schema: description: An array of campaigns. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaigns: description: An array of campaigns. items: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together. enum: - template - html - url - multichannel title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens, clicks, and e-commerce data. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object title: RSS Options type: object send_time: description: The date and time a campaign was sent. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: false title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer title: Campaign type: object title: Campaigns type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List campaigns tags: - campaigns x-custom-config: methodNameCamel: list methodNameSnake: list post: deprecated: false description: Create a new Mailchimp campaign. operationId: postCampaigns requestBody: content: application/json: schema: description: A summary of an individual campaign's settings and content. properties: 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. enum: - template - multichannel example: template title: Content Type type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object required: - list_id title: List type: object rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options, specific to an RSS campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object required: - feed_url - frequency title: RSS Options type: object settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: "The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending." title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id of the template to use. title: Template ID type: integer title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string required: - winner_criteria title: A/B Test Options type: object required: - type title: Campaign type: object required: true responses: "200": content: application/json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together. enum: - template - html - url - multichannel title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens, clicks, and e-commerce data. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object title: RSS Options type: object send_time: description: The date and time a campaign was sent. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: false title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer title: Campaign type: object application/problem+json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together. enum: - template - html - url - multichannel title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens, clicks, and e-commerce data. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object title: RSS Options type: object send_time: description: The date and time a campaign was sent. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: false title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer title: Campaign type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add campaign tags: - campaigns x-custom-config: methodNameCamel: create methodNameSnake: create "/campaigns/{campaign_id}": delete: deprecated: false description: Remove a campaign from your Mailchimp account. operationId: deleteCampaignsId parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete campaign tags: - campaigns x-custom-config: methodNameCamel: remove methodNameSnake: remove get: deprecated: false description: Get information about a specific campaign. operationId: getCampaignsId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "200": content: application/json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together. enum: - template - html - url - multichannel title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens, clicks, and e-commerce data. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object title: RSS Options type: object send_time: description: The date and time a campaign was sent. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: false title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer title: Campaign type: object application/problem+json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together. enum: - template - html - url - multichannel title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens, clicks, and e-commerce data. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object title: RSS Options type: object send_time: description: The date and time a campaign was sent. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: false title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer title: Campaign type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get campaign info tags: - campaigns x-custom-config: methodNameCamel: get methodNameSnake: get patch: description: Update some or all of the settings for a specific campaign. operationId: patchCampaignsId parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID requestBody: content: application/json: schema: description: A summary of an individual campaign's settings and content. properties: recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object required: - list_id title: List type: object rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object required: - feed_url - frequency title: RSS Options type: object settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id of the template to use. title: Template ID type: integer title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean required: - subject_line - from_name - reply_to title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object variate_settings: description: The settings specific to A/B test campaigns. properties: 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string required: - winner_criteria title: A/B Test Options type: object required: - settings title: Campaign type: object required: true responses: "200": content: application/json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together. enum: - template - html - url - multichannel title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens, clicks, and e-commerce data. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object title: RSS Options type: object send_time: description: The date and time a campaign was sent. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: false title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer title: Campaign type: object application/problem+json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version in ISO 8601 format. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together. enum: - template - html - url - multichannel title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string title: List type: object report_summary: description: For sent campaigns, a summary of opens, clicks, and e-commerce data. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object 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/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object title: RSS Options type: object send_time: description: The date and time a campaign was sent. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: false title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage out-of-office replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer title: Campaign type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update campaign settings tags: - campaigns x-custom-config: methodNameCamel: update methodNameSnake: update "/campaigns/{campaign_id}/actions/cancel-send": post: deprecated: false description: Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro. operationId: postCampaignsIdActionsCancelSend parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Cancel campaign tags: - campaigns x-custom-config: methodNameCamel: cancelSend methodNameSnake: cancel_send x-pro-required: true "/campaigns/{campaign_id}/actions/create-resend": post: deprecated: false description: Creates a Resend to Non-Openers version of this campaign. We will also check if this campaign meets the criteria for Resend to Non-Openers campaigns. operationId: postCampaignsIdActionsCreateResend parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "200": content: application/json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string required: - list_id title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object hour: description: The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object required: - feed_url - frequency title: RSS Options type: object send_time: description: The date and time a campaign was sent in ISO 8601 format. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: true title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string required: - winner_criteria title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer required: - type title: Campaign type: object application/problem+json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string required: - list_id title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object hour: description: The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object required: - feed_url - frequency title: RSS Options type: object send_time: description: The date and time a campaign was sent in ISO 8601 format. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: true title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string required: - winner_criteria title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer required: - type title: Campaign type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Resend campaign tags: - campaigns x-custom-config: methodNameCamel: createResend methodNameSnake: create_resend x-pro-required: true "/campaigns/{campaign_id}/actions/pause": post: deprecated: false description: Pause an RSS-Driven campaign. operationId: postCampaignsIdActionsPause parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Pause rss campaign tags: - campaigns x-custom-config: methodNameCamel: pause methodNameSnake: pause "/campaigns/{campaign_id}/actions/replicate": post: deprecated: false description: Replicate a campaign in saved or send status. operationId: postCampaignsIdActionsReplicate parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "200": content: application/json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string required: - list_id title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object hour: description: The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object required: - feed_url - frequency title: RSS Options type: object send_time: description: The date and time a campaign was sent in ISO 8601 format. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: true title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string required: - winner_criteria title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer required: - type title: Campaign type: object application/problem+json: schema: description: A summary of an individual campaign's settings and content. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array ab_split_opts: description: "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign." properties: from_name_a: description: For campaigns split on 'From Name', the name for Group A. title: From Name Group A type: string from_name_b: description: For campaigns split on 'From Name', the name for Group B. title: From Name Group B type: string pick_winner: description: How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual title: Pick Winner type: string reply_email_a: description: For campaigns split on 'From Name', the reply-to address for Group A. title: Reply Email Group A type: string reply_email_b: description: For campaigns split on 'From Name', the reply-to address for Group B. title: Reply Email Group B type: string send_time_a: description: The send time for Group A. format: date-time title: Send Time Group A type: string send_time_b: description: The send time for Group B. format: date-time title: Send Time Group B type: string send_time_winner: description: The send time for the winning version. title: Send Time Winner type: string split_size: description: The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. maximum: 50 minimum: 1 title: Split Size type: integer split_test: description: The type of AB split to run. enum: - subject - from_name - schedule title: Split Test type: string subject_a: description: For campaigns split on 'Subject Line', the subject line for Group A. title: Subject Line Group A type: string subject_b: description: For campaigns split on 'Subject Line', the subject line for Group B. title: Subject Line Group B type: string wait_time: description: The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. title: Wait Time type: integer wait_units: description: How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days title: Wait Time type: string readOnly: true title: A/B Testing Options type: object archive_url: description: The link to the campaign's archive version. readOnly: true title: Archive URL type: string content_type: description: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). readOnly: true title: Content Type type: string create_time: description: The date and time the campaign was created in ISO 8601 format. format: date-time readOnly: true title: Create Time type: string delivery_status: description: Updates on campaigns in the process of sending. properties: can_cancel: description: Whether a campaign send can be canceled. readOnly: true title: Campaign Cancelable type: boolean emails_canceled: description: The total number of emails canceled for this campaign. readOnly: true title: Emails Canceled type: integer emails_sent: description: The total number of emails confirmed sent for this campaign so far. readOnly: true title: Emails Sent type: integer enabled: description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true title: Delivery Status Enabled type: boolean status: description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true title: Campaign Delivery Status type: string title: Campaign Delivery Status type: object emails_sent: description: The total number of emails sent for this campaign. readOnly: true title: Emails Sent type: integer id: description: A string that uniquely identifies this campaign. readOnly: true title: Campaign ID type: string long_archive_url: description: The original link to the campaign's archive version. readOnly: true title: Long Archive URL type: string needs_block_refresh: description: Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true title: Needs Block Refresh type: boolean parent_campaign_id: description: If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true title: Parent Campaign ID type: string recipients: description: List settings for the campaign. properties: list_id: description: The unique list id. title: List ID type: string list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific US zip code. enum: - ipgeoinzip example: ipgeoinzip title: Segment Operator type: string value: description: The radius of the target location. example: 25 title: Segment Data type: integer required: - field - op - value - extra title: US Zip Code Segment type: object - description: Segment members whose location information is unknown. properties: condition_type: enum: - IPGeoUnknown type: string x-value: IPGeoUnknown field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members for which location information is unknown. enum: - ipgeounknown example: ipgeounknown title: Segment Operator type: string required: - field - op title: Unknown Location-Based Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoZip type: string x-value: IPGeoZip field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are/are not within a specific US zip code. enum: - ipgeoiszip - ipgeonotzip example: ipgeonotzip title: Segment Operator type: string value: description: The 5-digit zip code. example: 30318 title: Segment Data type: integer required: - field - op - value title: Zip Code Location-Based Segment type: object - description: Segment by age ranges in Social Profiles data. properties: condition_type: enum: - SocialAge type: string x-value: SocialAge field: description: Segment by age ranges in Social Profiles data. enum: - social_age example: social_age title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The age range to segment. enum: - 18-24 - 25-34 - 35-54 - 55+ example: 35-54 title: Segment Operator type: string required: - field - op - value title: Social Profiles Age Segment type: object - description: Segment by listed gender in Social Profiles data. properties: condition_type: enum: - SocialGender type: string x-value: SocialGender field: description: Segment by listed gender in Social Profiles data. enum: - social_gender example: social_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The Social Profiles gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Social Profiles Gender Segment type: object - description: Segment by influence rating in Social Profiles data. properties: condition_type: enum: - SocialInfluence type: string x-value: SocialInfluence field: description: Segment by influence rating in Social Profiles data. enum: - social_influence example: social_influence title: Segment Field type: string op: description: Members who have a rating that is/not or greater/less than the rating provided. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The Social Profiles influence rating to segment. example: 2 title: Segment Operator type: number required: - field - op - value title: Social Profiles Influence Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkMember type: string x-value: SocialNetworkMember field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not on a given social network. enum: - member - notmember example: member title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube example: twitter title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Segment type: object - description: Segment by social network in Social Profiles data. properties: condition_type: enum: - SocialNetworkFollow type: string x-value: SocialNetworkFollow field: description: Segment by social network in Social Profiles data. enum: - social_network example: social_network title: Segment Field type: string op: description: Members who are/not following a linked account on a given social network. enum: - follow - notfollow example: follow title: Segment Operator type: string value: description: The social network to segment against. enum: - twitter_follow example: twitter_follow title: Segment Operator type: string required: - field - op - value title: Social Profiles Social Network Follow Segment type: object - description: Segment by an address-type merge field. properties: condition_type: enum: - AddressMerge type: string x-value: AddressMerge field: description: An address-type merge field to segment. example: MMERGE3 title: Segment Field type: string op: description: Whether the member's address merge field contains/does not contain a value or is/is not blank. enum: - contains - notcontain - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Atlanta title: Segment Value type: string required: - field - op title: Address Merge Field Segment type: object - description: Segment by an address-type merge field within a given distance. properties: condition_type: enum: - ZipMerge type: string x-value: ZipMerge extra: description: The city or the zip being used to segment against. example: "30318" title: Segment Extra type: string field: description: An address or zip-type merge field to segment. example: MMERGE2 title: Segment Field type: string op: description: Whether the member's address merge field is within a given distance from a city or zip. enum: - geoin example: geoin title: Segment Operator type: string value: description: The distance from the city/zip. example: "25" title: Segment Value type: string required: - field - op - value - extra title: Address/Zip Merge Field Segment type: object - description: Segment by a contact's birthday. properties: condition_type: enum: - BirthdayMerge type: string x-value: BirthdayMerge field: description: A date merge field to segment. example: MMERGE4 title: Segment Field type: string op: description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. enum: - is - not - blank - blank_not example: is title: Segment Operator type: string value: description: A date to segment against (mm/dd). example: 01/30 title: Segment Value type: string required: - field - op title: Birthday Merge Field Segment type: object - description: Segment by a given date merge field. properties: condition_type: enum: - DateMerge type: string x-value: DateMerge field: description: A date merge field to segment. example: MMERGE5 title: Segment Field type: string op: description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. enum: - is - not - less - blank - blank_not - greater example: is title: Segment Operator type: string value: description: A date to segment against. example: 01/30/2015 title: Segment Value type: string required: - field - op title: Date Merge Field Segment type: object - description: An individual segment condition properties: condition_type: enum: - SelectMerge type: string x-value: SelectMerge field: description: A merge field to segment. example: MMERGE6 title: Segment Field type: string op: description: Whether the member's merge information is/is not a value or is/is not blank. enum: - is - not - blank - blank_not - notcontain - contains example: is title: Segment Operator type: string value: description: The value to segment a text merge field with. example: Second Choice title: Segment Value type: string required: - field - op title: Dropdown/Radio Merge Field Segment type: object - description: Segment by a given text or number merge field. properties: condition_type: enum: - TextMerge type: string x-value: TextMerge field: description: A text or number merge field to segment. example: MMERGE7 title: Segment Field type: string op: description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not example: contains title: Segment Operator type: string value: description: The value to segment a text or number merge field with. example: Freddie's Jokes title: Segment Value type: string required: - field - op title: Text or Number Merge Field Segment type: object - description: Segment by email address. properties: condition_type: enum: - EmailAddress type: string x-value: EmailAddress field: description: Segmenting based off of a subscriber's email address. enum: - merge0 - EMAIL example: EMAIL title: Segment Field type: string op: description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator type: string value: description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com title: Segment Value type: string required: - field - op title: Email Segment type: object - description: Segment by predicted gender. properties: condition_type: enum: - PredictedGender type: string x-value: PredictedGender field: description: Segment by predicted gender. enum: - predicted_gender title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is - not example: is title: Segment Operator type: string value: description: The predicted gender to segment. enum: - male - female example: female title: Segment Operator type: string required: - field - op - value title: Predicted Gender Segment type: object - description: Segment by predicted age. properties: condition_type: enum: - PredictedAge type: string x-value: PredictedAge field: description: Segment by predicted age. enum: - predicted_age_range title: Segment Field type: string op: description: Members who are/not the exact criteria listed. enum: - is example: is title: Segment Operator type: string value: description: The predicted age to segment. enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ example: female title: Segment Operator type: string required: - field - op - value title: Predicted Age Segment type: object - description: Segment by when people subscribed. properties: condition_type: enum: - NewSubscribers type: string x-value: NewSubscribers field: description: Segment by when people subscribed. enum: - timestamp_opt title: Segment Field type: string op: description: Whe the event took place, namely within a time frame. enum: - date_within title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." title: Segment Data type: string title: New Subscribers Prebuilt Segment type: object title: Segment Type type: array match: description: Segment match type. enum: - any - all title: Match Type type: string prebuilt_segment_id: description: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. example: subscribers-female title: Prebuilt Segment Id type: string saved_segment_id: description: The id for an existing saved segment. title: Saved Segment ID type: integer title: Segment Options type: object segment_text: description: A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML. readOnly: true title: Segment Text type: string required: - list_id title: List type: object report_summary: description: For sent campaigns, a summary of opens and clicks. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. readOnly: true title: Click Rate type: number clicks: description: The total number of clicks for an campaign. readOnly: true title: Total Clicks type: integer ecommerce: description: E-Commerce stats for a campaign. properties: total_orders: description: The total orders for a campaign. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true title: Total Revenue type: number total_spent: description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true title: Total Spent type: number title: E-Commerce Report type: object open_rate: description: The number of unique opens divided by the total number of successful deliveries. readOnly: true title: Open Rate type: number opens: description: The total number of opens for a campaign. readOnly: true title: Automation Opens type: integer subscriber_clicks: description: The number of unique clicks. readOnly: true title: Unique Subscriber Clicks type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer title: Campaign Report Summary type: object resendable: description: Determines if the campaign qualifies to be resent to non-openers. readOnly: true title: Resendable type: boolean rss_opts: description: "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign." properties: constrain_rss_img: description: Whether to add CSS to images in the RSS feed to constrain their width in campaigns. title: Constrain RSS Images type: boolean feed_url: description: The URL for the RSS feed. format: uri title: Feed URL type: string frequency: description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly title: Frequency type: string last_sent: description: The date the campaign was last sent. format: date-time readOnly: true title: Last Sent type: string schedule: description: The schedule for sending the RSS Campaign. properties: daily_send: description: The days of the week to send a daily RSS Campaign. properties: friday: description: Sends the daily RSS Campaign on Fridays. title: Friday type: boolean monday: description: Sends the daily RSS Campaign on Mondays. title: Monday type: boolean saturday: description: Sends the daily RSS Campaign on Saturdays. title: Saturday type: boolean sunday: description: Sends the daily RSS Campaign on Sundays. title: Sunday type: boolean thursday: description: Sends the daily RSS Campaign on Thursdays. title: Thursday type: boolean tuesday: description: Sends the daily RSS Campaign on Tuesdays. title: tuesday type: boolean wednesday: description: Sends the daily RSS Campaign on Wednesdays. title: Monday type: boolean title: Daily Sending Days type: object hour: description: The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/). maximum: 23 minimum: 0 title: Sending Hour type: integer monthly_send_date: 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. maximum: 31 minimum: 0 title: Monthly Sending Day type: number weekly_send_day: description: The day of the week to send a weekly RSS Campaign. enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day type: string title: Sending Schedule type: object required: - feed_url - frequency title: RSS Options type: object send_time: description: The date and time a campaign was sent in ISO 8601 format. format: date-time readOnly: true title: Send Time type: string settings: description: The settings for your campaign, including subject, from name, reply-to address, and more. properties: authenticate: description: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. title: Authentication type: boolean auto_fb_post: description: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. items: type: string title: Auto Post to Facebook type: array auto_footer: description: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. title: Auto-Footer type: boolean 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. title: Auto-Tweet type: boolean drag_and_drop: description: Whether the campaign uses the drag-and-drop editor. readOnly: true title: Drag And Drop Campaign type: boolean fb_comments: description: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. title: Facebook Comments type: boolean folder_id: description: If the campaign is listed in a folder, the id for that folder. title: Folder ID type: string from_name: description: The 'from' name on the campaign (not an email address). title: From Name type: string inline_css: description: Automatically inline the CSS included with the campaign content. title: Inline CSS type: boolean preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string reply_to: description: The reply-to email address for the campaign. title: Reply To Address type: string subject_line: description: The subject line for the campaign. title: Campaign Subject Line type: string template_id: description: The id for the template used in this campaign. readOnly: true title: Template ID type: integer timewarp: description: Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true title: Timewarp Send type: boolean title: description: The title of the campaign. title: Campaign Title type: string to_name: description: The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). title: To Name type: string use_conversation: description: Use Mailchimp Conversation feature to manage replies. title: Conversation type: boolean title: Campaign Settings type: object 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: description: description: A short summary of the campaign to display. title: Campaign Description type: string image_url: description: The url for the header image for the card. title: Image URL type: string title: description: The title for the card. Typically the subject line of the campaign. title: Title type: string title: Campaign Social Card type: object status: description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived readOnly: true title: Campaign Status type: string tracking: description: The tracking options for a campaign. properties: capsule: description: Deprecated properties: notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Capsule Note type: boolean title: Capsule CRM Tracking type: object clicktale: description: The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). title: ClickTale Analytics Tracking type: string ecomm360: description: Whether to enable e-commerce tracking. title: E-commerce Tracking type: boolean goal_tracking: description: Deprecated title: Mailchimp Goal Tracking type: boolean google_analytics: description: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). title: Google Analytics Tracking type: string html_clicks: 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. title: HTML Click Tracking type: boolean opens: description: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns. title: Opens type: boolean salesforce: description: Deprecated properties: campaign: description: Create a campaign in a connected Salesforce account. title: Salesforce Campaign type: boolean notes: description: Update contact notes for a campaign based on subscriber email addresses. title: Salesforce Note type: boolean title: Salesforce CRM Tracking type: object text_clicks: 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. title: Plain-Text Click Tracking type: boolean title: Campaign Tracking Options type: object 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 title: Campaign Type type: string variate_settings: description: The settings specific to A/B test campaigns. properties: combinations: description: Combinations of possible variables used to build emails. items: properties: content_description: description: The index of `variate_settings.contents` used. title: Content Description type: integer from_name: description: The index of `variate_settings.from_names` used. title: From Name type: integer id: description: Unique ID for the combination. title: ID type: string recipients: description: The number of recipients for this combination. title: Recipients type: integer reply_to: description: The index of `variate_settings.reply_to_addresses` used. title: Reply To type: integer send_time: description: The index of `variate_settings.send_times` used. title: Send Time type: integer subject_line: description: The index of `variate_settings.subject_lines` used. title: Subject Line type: integer type: object readOnly: true title: Combinations type: array contents: description: Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true title: Content Descriptions type: array 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 title: From Names type: array 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 title: Reply To Addresses type: array 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: format: date-time type: string title: Send Times type: array subject_lines: description: The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string title: Subject Lines type: array test_size: description: The percentage of recipients to send the test combinations to, must be a value between 10 and 100. title: Test Size type: integer 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. title: Wait Time type: integer winner_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 title: Winning Criteria type: string winning_campaign_id: description: ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true title: Winning Campaign ID type: string winning_combination_id: description: ID for the winning combination. readOnly: true title: Winning Combination ID type: string required: - winner_criteria title: A/B Test Options type: object web_id: description: The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true title: Campaign Web ID type: integer required: - type title: Campaign type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Replicate campaign tags: - campaigns x-custom-config: methodNameCamel: replicate methodNameSnake: replicate "/campaigns/{campaign_id}/actions/resume": post: deprecated: false description: Resume an RSS-Driven campaign. operationId: postCampaignsIdActionsResume parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Resume rss campaign tags: - campaigns x-custom-config: methodNameCamel: resume methodNameSnake: resume "/campaigns/{campaign_id}/actions/schedule": post: deprecated: false description: Schedule a campaign for delivery. If you're using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead. operationId: postCampaignsIdActionsSchedule parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID requestBody: content: application/json: schema: properties: batch_delivery: description: Choose whether the campaign should use [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/). Cannot be set to `true` for campaigns using [Timewarp](https://mailchimp.com/help/use-timewarp/). properties: batch_count: description: The number of batches for the campaign send. title: Batch Count type: integer batch_delay: description: The delay, in minutes, between batches. title: Batch Delay type: integer required: - batch_delay - batch_count title: Batch Delivery type: object schedule_time: description: The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45). format: date-time title: Schedule Time type: string timewarp: description: Choose whether the campaign should use [Timewarp](https://mailchimp.com/help/use-timewarp/) when sending. Campaigns scheduled with Timewarp are localized based on the recipients' time zones. For example, a Timewarp campaign with a `schedule_time` of 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set to `true` for campaigns using [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/). title: Timewarp type: boolean required: - schedule_time type: object required: true responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Schedule campaign tags: - campaigns x-custom-config: methodNameCamel: schedule methodNameSnake: schedule "/campaigns/{campaign_id}/actions/send": post: deprecated: false description: Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately. operationId: postCampaignsIdActionsSend parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Send campaign tags: - campaigns x-custom-config: methodNameCamel: send methodNameSnake: send "/campaigns/{campaign_id}/actions/test": post: deprecated: false description: Send a test email. operationId: postCampaignsIdActionsTest parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID requestBody: content: application/json: schema: properties: send_type: description: Choose the type of test email to send. enum: - html - plaintext title: Type of email to test type: string test_emails: description: An array of email addresses to send the test email to. items: type: string title: Test Emails type: array required: - test_emails - send_type type: object required: true responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Send test email tags: - campaigns x-custom-config: methodNameCamel: sendTestEmail methodNameSnake: send_test_email "/campaigns/{campaign_id}/actions/unschedule": post: deprecated: false description: Unschedule a scheduled campaign that hasn't started sending. operationId: postCampaignsIdActionsUnschedule parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Unschedule campaign tags: - campaigns x-custom-config: methodNameCamel: unschedule methodNameSnake: unschedule "/campaigns/{campaign_id}/content": get: deprecated: false description: Get the the HTML and plain-text content for a campaign. operationId: getCampaignsIdContent parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "200": content: application/json: schema: description: The HTML and plain-text content for a campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_html: description: The Archive HTML for the campaign. example: My Subject title: Campaign Archive HTML type: string html: description: The raw HTML for the campaign. title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string variate_contents: description: Content options for multivariate campaigns. items: properties: content_label: description: Label used to identify the content option. example: Green header title: Content Label type: string html: description: The raw HTML for the campaign. example: *|MC:SUBJECT|* title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string type: object title: Variate Contents type: array title: Campaign Content type: object application/problem+json: schema: description: The HTML and plain-text content for a campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_html: description: The Archive HTML for the campaign. example: My Subject title: Campaign Archive HTML type: string html: description: The raw HTML for the campaign. title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string variate_contents: description: Content options for multivariate campaigns. items: properties: content_label: description: Label used to identify the content option. example: Green header title: Content Label type: string html: description: The raw HTML for the campaign. example: *|MC:SUBJECT|* title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string type: object title: Variate Contents type: array title: Campaign Content type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get campaign content tags: - campaigns x-custom-config: methodNameCamel: getContent methodNameSnake: get_content put: deprecated: false description: Set the content for a campaign. operationId: putCampaignsIdContent parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID requestBody: content: application/json: schema: description: The HTML and plain-text content for a campaign properties: 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/). properties: archive_content: description: The base64-encoded representation of the archive file. title: Archive Content type: string archive_type: description: The type of encoded file. Defaults to zip. enum: - zip - tar.gz - tar.bz2 - tar - tgz - tbz title: Archive Type type: string required: - archive_content title: Upload Archive type: object html: description: The raw HTML for the campaign. title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string template: description: Use this template to generate the HTML content of the campaign properties: id: description: The id of the template to use. title: Template ID type: integer 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. title: Template Sections type: object required: - id title: Template Content type: object url: description: When importing a campaign, the URL where the HTML lives. title: Campaign URL type: string 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: properties: 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/). properties: archive_content: description: The base64-encoded representation of the archive file. title: Archive Content type: string archive_type: description: The type of encoded file. Defaults to zip. enum: - zip - tar.gz - tar.bz2 - tar - tgz - tbz title: Archive Type type: string required: - archive_content title: Upload Archive type: object content_label: description: The label used to identify the content option. title: Content Label type: string html: description: The raw HTML for the campaign. title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string template: description: Use this template to generate the HTML content for the campaign. properties: id: description: The id of the template to use. title: Template ID type: integer 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. title: Template Sections type: object required: - id title: Template Content type: object url: description: When importing a campaign, the URL for the HTML. title: Campaign URL type: string required: - content_label type: object title: Variate Contents type: array title: Campaign Content type: object required: true responses: "200": content: application/json: schema: description: The HTML and plain-text content for a campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_html: description: The Archive HTML for the campaign. example: My Subject title: Campaign Archive HTML type: string html: description: The raw HTML for the campaign. title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string variate_contents: description: Content options for multivariate campaigns. items: properties: content_label: description: Label used to identify the content option. example: Green header title: Content Label type: string html: description: The raw HTML for the campaign. example: *|MC:SUBJECT|* title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string type: object title: Variate Contents type: array title: Campaign Content type: object application/problem+json: schema: description: The HTML and plain-text content for a campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array archive_html: description: The Archive HTML for the campaign. example: My Subject title: Campaign Archive HTML type: string html: description: The raw HTML for the campaign. title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string variate_contents: description: Content options for multivariate campaigns. items: properties: content_label: description: Label used to identify the content option. example: Green header title: Content Label type: string html: description: The raw HTML for the campaign. example: *|MC:SUBJECT|* title: Campaign HTML type: string plain_text: description: The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. title: Plain Text type: string type: object title: Variate Contents type: array title: Campaign Content type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Set campaign content tags: - campaigns x-custom-config: methodNameCamel: setContent methodNameSnake: set_content "/campaigns/{campaign_id}/feedback": get: deprecated: false description: Get team feedback while you're working together on a Mailchimp campaign. operationId: getCampaignsIdFeedback parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "200": content: application/json: schema: description: A summary of the comment feedback for a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string feedback: description: A collection of feedback items for a campaign. items: description: A specific feedback message from a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string created_at: description: The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true title: Created At type: string created_by: description: The login name of the user who created the feedback. readOnly: true title: Created By type: string feedback_id: description: The individual id for the feedback item. readOnly: true title: Feedback ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string parent_id: description: If a reply, the id of the parent feedback item. readOnly: true title: Parent ID type: integer source: description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true title: Source type: string updated_at: description: The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated At type: string required: - message title: Campaign Feedback type: object title: Campaign Feedback type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Campaign Reports type: object application/problem+json: schema: description: A summary of the comment feedback for a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string feedback: description: A collection of feedback items for a campaign. items: description: A specific feedback message from a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string created_at: description: The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true title: Created At type: string created_by: description: The login name of the user who created the feedback. readOnly: true title: Created By type: string feedback_id: description: The individual id for the feedback item. readOnly: true title: Feedback ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string parent_id: description: If a reply, the id of the parent feedback item. readOnly: true title: Parent ID type: integer source: description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true title: Source type: string updated_at: description: The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated At type: string required: - message title: Campaign Feedback type: object title: Campaign Feedback type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Campaign Reports type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List campaign feedback tags: - campaigns x-custom-config: methodNameCamel: getFeedback methodNameSnake: get_feedback post: deprecated: false description: Add feedback on a specific campaign. operationId: postCampaignsIdFeedback parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID requestBody: content: application/json: schema: description: A specific feedback message from a specific campaign. properties: block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string required: - message title: Campaign Feedback type: object required: true responses: "200": content: application/json: schema: description: A specific feedback message from a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string created_at: description: The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true title: Created At type: string created_by: description: The login name of the user who created the feedback. readOnly: true title: Created By type: string feedback_id: description: The individual id for the feedback item. readOnly: true title: Feedback ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string parent_id: description: If a reply, the id of the parent feedback item. readOnly: true title: Parent ID type: integer source: description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true title: Source type: string updated_at: description: The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated At type: string title: Campaign Feedback type: object application/problem+json: schema: description: A specific feedback message from a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string created_at: description: The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true title: Created At type: string created_by: description: The login name of the user who created the feedback. readOnly: true title: Created By type: string feedback_id: description: The individual id for the feedback item. readOnly: true title: Feedback ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string parent_id: description: If a reply, the id of the parent feedback item. readOnly: true title: Parent ID type: integer source: description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true title: Source type: string updated_at: description: The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated At type: string title: Campaign Feedback type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add campaign feedback tags: - campaigns x-custom-config: methodNameCamel: addFeedback methodNameSnake: add_feedback "/campaigns/{campaign_id}/feedback/{feedback_id}": delete: deprecated: false description: Remove a specific feedback message for a campaign. operationId: deleteCampaignsIdFeedbackId parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID - description: The unique id for the feedback message. in: path name: feedback_id required: true schema: type: string x-title: Feedback ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete campaign feedback message tags: - campaigns x-custom-config: methodNameCamel: deleteFeedbackMessage methodNameSnake: delete_feedback_message get: deprecated: false description: Get a specific feedback message from a campaign. operationId: getCampaignsIdFeedbackId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID - description: The unique id for the feedback message. in: path name: feedback_id required: true schema: type: string x-title: Feedback ID responses: "200": content: application/json: schema: description: A specific feedback message from a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string created_at: description: The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true title: Created At type: string created_by: description: The login name of the user who created the feedback. readOnly: true title: Created By type: string feedback_id: description: The individual id for the feedback item. readOnly: true title: Feedback ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string parent_id: description: If a reply, the id of the parent feedback item. readOnly: true title: Parent ID type: integer source: description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true title: Source type: string updated_at: description: The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated At type: string title: Campaign Feedback type: object application/problem+json: schema: description: A specific feedback message from a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string created_at: description: The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true title: Created At type: string created_by: description: The login name of the user who created the feedback. readOnly: true title: Created By type: string feedback_id: description: The individual id for the feedback item. readOnly: true title: Feedback ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string parent_id: description: If a reply, the id of the parent feedback item. readOnly: true title: Parent ID type: integer source: description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true title: Source type: string updated_at: description: The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated At type: string title: Campaign Feedback type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get campaign feedback message tags: - campaigns x-custom-config: methodNameCamel: getFeedbackMessage methodNameSnake: get_feedback_message patch: deprecated: false description: Update a specific feedback message for a campaign. operationId: patchCampaignsIdFeedbackId parameters: - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID - description: The unique id for the feedback message. in: path name: feedback_id required: true schema: type: string x-title: Feedback ID requestBody: content: application/json: schema: description: A specific feedback message from a specific campaign. properties: block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string title: Campaign Feedback type: object required: true responses: "200": content: application/json: schema: description: A specific feedback message from a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string created_at: description: The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true title: Created At type: string created_by: description: The login name of the user who created the feedback. readOnly: true title: Created By type: string feedback_id: description: The individual id for the feedback item. readOnly: true title: Feedback ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string parent_id: description: If a reply, the id of the parent feedback item. readOnly: true title: Parent ID type: integer source: description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true title: Source type: string updated_at: description: The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated At type: string title: Campaign Feedback type: object application/problem+json: schema: description: A specific feedback message from a specific campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array block_id: description: The block id for the editable block that the feedback addresses. title: Block ID type: integer campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string created_at: description: The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true title: Created At type: string created_by: description: The login name of the user who created the feedback. readOnly: true title: Created By type: string feedback_id: description: The individual id for the feedback item. readOnly: true title: Feedback ID type: integer is_complete: description: The status of feedback. title: Complete type: boolean message: description: The content of the feedback. title: Message type: string parent_id: description: If a reply, the id of the parent feedback item. readOnly: true title: Parent ID type: integer source: description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true title: Source type: string updated_at: description: The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated At type: string title: Campaign Feedback type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update campaign feedback message tags: - campaigns x-custom-config: methodNameCamel: updateFeedbackMessage methodNameSnake: update_feedback_message "/campaigns/{campaign_id}/send-checklist": get: deprecated: false description: Review the send checklist for a campaign, and resolve any issues before sending. operationId: getCampaignsIdSendChecklist parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID responses: "200": content: application/json: schema: description: The send checklist for the campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array is_ready: description: Whether the campaign is ready to send. title: Ready? type: boolean items: description: A list of feedback items to review before sending your campaign. items: properties: details: description: Details about the specific feedback item. title: Details type: string heading: description: The heading for the specific item. title: Heading type: string id: description: The ID for the specific item. title: ID type: integer type: description: The item type. enum: - success - warning - error title: Type type: string type: object title: Items type: array title: Send Checklist type: object application/problem+json: schema: description: The send checklist for the campaign. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array is_ready: description: Whether the campaign is ready to send. title: Ready? type: boolean items: description: A list of feedback items to review before sending your campaign. items: properties: details: description: Details about the specific feedback item. title: Details type: string heading: description: The heading for the specific item. title: Heading type: string id: description: The ID for the specific item. title: ID type: integer type: description: The item type. enum: - success - warning - error title: Type type: string type: object title: Items type: array title: Send Checklist type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get campaign send checklist tags: - campaigns x-custom-config: methodNameCamel: getSendChecklist methodNameSnake: get_send_checklist /connected-sites: get: deprecated: false description: Get all connected sites in an account. operationId: getConnectedSites parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset responses: "200": content: application/json: schema: description: A collection of connected sites in the account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array sites: description: An array of objects, each representing a connected site. items: description: Information about a specific connected site. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array created_at: description: The date and time the connected site was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string domain: description: The connected site domain. example: example.myshopify.com readOnly: true title: Domain type: string foreign_id: description: The unique identifier for the site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string platform: description: The platform of the connected site. example: shopify, magento, bigcommerce, woocommerce readOnly: true title: Connected Site Platform type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js title: Script URL type: string readOnly: true title: Script type: object store_id: description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. example: MC001 readOnly: true title: Store ID type: string updated_at: description: The date and time the connected site was last updated in ISO 8601 format. example: 2015-07-15T19:35:00+00:00 format: date-time readOnly: true title: Update Time type: string title: Connected Site type: object title: Connected Sites type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Connected Sites type: object application/problem+json: schema: description: A collection of connected sites in the account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array sites: description: An array of objects, each representing a connected site. items: description: Information about a specific connected site. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array created_at: description: The date and time the connected site was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string domain: description: The connected site domain. example: example.myshopify.com readOnly: true title: Domain type: string foreign_id: description: The unique identifier for the site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string platform: description: The platform of the connected site. example: shopify, magento, bigcommerce, woocommerce readOnly: true title: Connected Site Platform type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js title: Script URL type: string readOnly: true title: Script type: object store_id: description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. example: MC001 readOnly: true title: Store ID type: string updated_at: description: The date and time the connected site was last updated in ISO 8601 format. example: 2015-07-15T19:35:00+00:00 format: date-time readOnly: true title: Update Time type: string title: Connected Site type: object title: Connected Sites type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Connected Sites type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List connected sites tags: - connectedSites x-custom-config: methodNameCamel: list methodNameSnake: list post: deprecated: false description: Create a new Mailchimp connected site. operationId: postConnectedSites requestBody: content: application/json: schema: description: Information about a specific connected site. properties: domain: description: The connected site domain. example: example.com title: Domain type: string foreign_id: description: The unique identifier for the site. example: MC001 title: Connected Site Foreign ID type: string required: - foreign_id - domain title: Connected Site type: object required: true responses: "200": content: application/json: schema: description: Information about a specific connected site. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array created_at: description: The date and time the connected site was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string domain: description: The connected site domain. example: example.myshopify.com readOnly: true title: Domain type: string foreign_id: description: The unique identifier for the site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string platform: description: The platform of the connected site. example: shopify, magento, bigcommerce, woocommerce readOnly: true title: Connected Site Platform type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js title: Script URL type: string readOnly: true title: Script type: object store_id: description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. example: MC001 readOnly: true title: Store ID type: string updated_at: description: The date and time the connected site was last updated in ISO 8601 format. example: 2015-07-15T19:35:00+00:00 format: date-time readOnly: true title: Update Time type: string title: Connected Site type: object application/problem+json: schema: description: Information about a specific connected site. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array created_at: description: The date and time the connected site was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string domain: description: The connected site domain. example: example.myshopify.com readOnly: true title: Domain type: string foreign_id: description: The unique identifier for the site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string platform: description: The platform of the connected site. example: shopify, magento, bigcommerce, woocommerce readOnly: true title: Connected Site Platform type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js title: Script URL type: string readOnly: true title: Script type: object store_id: description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. example: MC001 readOnly: true title: Store ID type: string updated_at: description: The date and time the connected site was last updated in ISO 8601 format. example: 2015-07-15T19:35:00+00:00 format: date-time readOnly: true title: Update Time type: string title: Connected Site type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add connected site tags: - connectedSites x-custom-config: methodNameCamel: create methodNameSnake: create "/connected-sites/{connected_site_id}": delete: deprecated: false description: Remove a connected site from your Mailchimp account. operationId: deleteConnectedSitesId parameters: - description: The unique identifier for the site. in: path name: connected_site_id required: true schema: type: string x-title: Connected Site Foreign ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete connected site tags: - connectedSites x-custom-config: methodNameCamel: remove methodNameSnake: remove get: deprecated: false description: Get information about a specific connected site. operationId: getConnectedSitesId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique identifier for the site. in: path name: connected_site_id required: true schema: type: string x-title: Connected Site Foreign ID responses: "200": content: application/json: schema: description: Information about a specific connected site. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array created_at: description: The date and time the connected site was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string domain: description: The connected site domain. example: example.myshopify.com readOnly: true title: Domain type: string foreign_id: description: The unique identifier for the site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string platform: description: The platform of the connected site. example: shopify, magento, bigcommerce, woocommerce readOnly: true title: Connected Site Platform type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js title: Script URL type: string readOnly: true title: Script type: object store_id: description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. example: MC001 readOnly: true title: Store ID type: string updated_at: description: The date and time the connected site was last updated in ISO 8601 format. example: 2015-07-15T19:35:00+00:00 format: date-time readOnly: true title: Update Time type: string title: Connected Site type: object application/problem+json: schema: description: Information about a specific connected site. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array created_at: description: The date and time the connected site was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string domain: description: The connected site domain. example: example.myshopify.com readOnly: true title: Domain type: string foreign_id: description: The unique identifier for the site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string platform: description: The platform of the connected site. example: shopify, magento, bigcommerce, woocommerce readOnly: true title: Connected Site Platform type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js title: Script URL type: string readOnly: true title: Script type: object store_id: description: The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. example: MC001 readOnly: true title: Store ID type: string updated_at: description: The date and time the connected site was last updated in ISO 8601 format. example: 2015-07-15T19:35:00+00:00 format: date-time readOnly: true title: Update Time type: string title: Connected Site type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get connected site tags: - connectedSites x-custom-config: methodNameCamel: get methodNameSnake: get "/connected-sites/{connected_site_id}/actions/verify-script-installation": post: deprecated: false description: Verify that the connected sites script has been installed, either via the script URL or fragment. operationId: postConnectedSitesIdActionsVerifyScriptInstallation parameters: - description: The unique identifier for the site. in: path name: connected_site_id required: true schema: type: string x-title: Connected Site Foreign ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Verify connected site script tags: - connectedSites x-custom-config: methodNameCamel: verifyScriptInstallation methodNameSnake: verify_script_installation x-pro-required: true /conversations: get: deprecated: true description: Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint. operationId: getConversations parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: Whether the conversation has any unread messages. in: query name: has_unread_messages required: false schema: enum: - "true" - "false" type: string x-title: Has Unread Messages - description: The unique id for the list. in: query name: list_id required: false schema: type: string x-title: List ID - description: The unique id for the campaign. in: query name: campaign_id required: false schema: type: string x-title: Campaign ID responses: "200": content: application/json: schema: description: A collection of this account's tracked conversations. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array conversations: description: A list of conversations. items: description: Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: The unique identifier of the campaign for this conversation. readOnly: true title: Campaign ID type: string from_email: description: A label representing the email of the sender of this message. readOnly: true title: From Email type: string from_label: description: A label representing the sender of this message. readOnly: true title: From Label type: string id: description: A string that uniquely identifies this conversation. readOnly: true title: ID type: string last_message: description: The most recent message in the conversation. properties: from_email: description: A label representing the email of the sender of this message. readOnly: true title: From Email type: string from_label: description: A label representing the sender of this message. readOnly: true title: From Label type: string message: description: The plain-text content of the message. readOnly: true title: Message type: string read: description: Whether this message has been marked as read. title: Read type: boolean subject: description: The subject of this message. readOnly: true title: Subject type: string timestamp: description: The date and time the message was either sent or received in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string title: Last Message type: object list_id: description: The unique identifier of the list for this conversation. readOnly: true title: List ID type: string message_count: description: The total number of messages in this conversation. readOnly: true title: Message Count type: integer subject: description: The subject of the message. readOnly: true title: Subject type: string unread_messages: description: The number of unread messages in this conversation. readOnly: true title: Unread Messages type: integer title: Conversation type: object title: Conversations type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Tracked Conversations type: object application/problem+json: schema: description: A collection of this account's tracked conversations. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array conversations: description: A list of conversations. items: description: Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: The unique identifier of the campaign for this conversation. readOnly: true title: Campaign ID type: string from_email: description: A label representing the email of the sender of this message. readOnly: true title: From Email type: string from_label: description: A label representing the sender of this message. readOnly: true title: From Label type: string id: description: A string that uniquely identifies this conversation. readOnly: true title: ID type: string last_message: description: The most recent message in the conversation. properties: from_email: description: A label representing the email of the sender of this message. readOnly: true title: From Email type: string from_label: description: A label representing the sender of this message. readOnly: true title: From Label type: string message: description: The plain-text content of the message. readOnly: true title: Message type: string read: description: Whether this message has been marked as read. title: Read type: boolean subject: description: The subject of this message. readOnly: true title: Subject type: string timestamp: description: The date and time the message was either sent or received in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string title: Last Message type: object list_id: description: The unique identifier of the list for this conversation. readOnly: true title: List ID type: string message_count: description: The total number of messages in this conversation. readOnly: true title: Message Count type: integer subject: description: The subject of the message. readOnly: true title: Subject type: string unread_messages: description: The number of unread messages in this conversation. readOnly: true title: Unread Messages type: integer title: Conversation type: object title: Conversations type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Tracked Conversations type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List conversations tags: - conversations x-custom-config: methodNameCamel: list methodNameSnake: list "/conversations/{conversation_id}": get: deprecated: true description: Get details about an individual conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint. operationId: getConversationsId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the conversation. in: path name: conversation_id required: true schema: type: string x-title: Conversation ID responses: "200": content: application/json: schema: description: Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: The unique identifier of the campaign for this conversation. readOnly: true title: Campaign ID type: string from_email: description: A label representing the email of the sender of this message. readOnly: true title: From Email type: string from_label: description: A label representing the sender of this message. readOnly: true title: From Label type: string id: description: A string that uniquely identifies this conversation. readOnly: true title: ID type: string last_message: description: The most recent message in the conversation. properties: from_email: description: A label representing the email of the sender of this message. readOnly: true title: From Email type: string from_label: description: A label representing the sender of this message. readOnly: true title: From Label type: string message: description: The plain-text content of the message. readOnly: true title: Message type: string read: description: Whether this message has been marked as read. title: Read type: boolean subject: description: The subject of this message. readOnly: true title: Subject type: string timestamp: description: The date and time the message was either sent or received in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string title: Last Message type: object list_id: description: The unique identifier of the list for this conversation. readOnly: true title: List ID type: string message_count: description: The total number of messages in this conversation. readOnly: true title: Message Count type: integer subject: description: The subject of the message. readOnly: true title: Subject type: string unread_messages: description: The number of unread messages in this conversation. readOnly: true title: Unread Messages type: integer title: Conversation type: object application/problem+json: schema: description: Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: The unique identifier of the campaign for this conversation. readOnly: true title: Campaign ID type: string from_email: description: A label representing the email of the sender of this message. readOnly: true title: From Email type: string from_label: description: A label representing the sender of this message. readOnly: true title: From Label type: string id: description: A string that uniquely identifies this conversation. readOnly: true title: ID type: string last_message: description: The most recent message in the conversation. properties: from_email: description: A label representing the email of the sender of this message. readOnly: true title: From Email type: string from_label: description: A label representing the sender of this message. readOnly: true title: From Label type: string message: description: The plain-text content of the message. readOnly: true title: Message type: string read: description: Whether this message has been marked as read. title: Read type: boolean subject: description: The subject of this message. readOnly: true title: Subject type: string timestamp: description: The date and time the message was either sent or received in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string title: Last Message type: object list_id: description: The unique identifier of the list for this conversation. readOnly: true title: List ID type: string message_count: description: The total number of messages in this conversation. readOnly: true title: Message Count type: integer subject: description: The subject of the message. readOnly: true title: Subject type: string unread_messages: description: The number of unread messages in this conversation. readOnly: true title: Unread Messages type: integer title: Conversation type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get conversation tags: - conversations x-custom-config: methodNameCamel: get methodNameSnake: get "/conversations/{conversation_id}/messages": get: deprecated: true description: Get messages from a specific conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint. operationId: getConversationsIdMessages parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the conversation. in: path name: conversation_id required: true schema: type: string x-title: Conversation ID - description: Whether a conversation message has been marked as read. in: query name: is_read required: false schema: enum: - "true" - "false" type: string x-title: Is Read - description: "Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_timestamp required: false schema: format: date-time type: string x-title: Before Timestamp - description: "Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_timestamp required: false schema: format: date-time type: string x-title: Since Timestamp responses: "200": content: application/json: schema: description: Messages from a specific conversation. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array conversation_id: description: A string that identifies this conversation. title: Conversation ID type: string conversation_messages: description: An array of objects, each representing a conversation messages resources. items: description: An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array conversation_id: description: A string that identifies this message's conversation readOnly: true title: Conversation ID type: string from_email: description: A label representing the email of the sender of this message title: From Email type: string from_label: description: A label representing the sender of this message readOnly: true title: From Label type: string id: description: A string that uniquely identifies this message readOnly: true title: ID type: string list_id: description: The list's web ID readOnly: true title: List ID type: integer message: description: The plain-text content of the message title: Message type: string read: description: Whether this message has been marked as read title: Read type: boolean subject: description: The subject of this message title: Subject type: string timestamp: description: The date and time the message was either sent or received in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string title: Conversation Message type: object title: Conversation Messages type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Collection of Conversation Messages type: object application/problem+json: schema: description: Messages from a specific conversation. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array conversation_id: description: A string that identifies this conversation. title: Conversation ID type: string conversation_messages: description: An array of objects, each representing a conversation messages resources. items: description: An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array conversation_id: description: A string that identifies this message's conversation readOnly: true title: Conversation ID type: string from_email: description: A label representing the email of the sender of this message title: From Email type: string from_label: description: A label representing the sender of this message readOnly: true title: From Label type: string id: description: A string that uniquely identifies this message readOnly: true title: ID type: string list_id: description: The list's web ID readOnly: true title: List ID type: integer message: description: The plain-text content of the message title: Message type: string read: description: Whether this message has been marked as read title: Read type: boolean subject: description: The subject of this message title: Subject type: string timestamp: description: The date and time the message was either sent or received in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string title: Conversation Message type: object title: Conversation Messages type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Collection of Conversation Messages type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List messages tags: - conversations x-custom-config: methodNameCamel: getConversationMessages methodNameSnake: get_conversation_messages "/conversations/{conversation_id}/messages/{message_id}": get: deprecated: true description: Get an individual message in a conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint. operationId: getConversationsIdMessagesId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The unique id for the conversation. in: path name: conversation_id required: true schema: type: string x-title: Conversation ID - description: The unique id for the conversation message. in: path name: message_id required: true schema: type: string x-title: Message ID responses: "200": content: application/json: schema: description: An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array conversation_id: description: A string that identifies this message's conversation readOnly: true title: Conversation ID type: string from_email: description: A label representing the email of the sender of this message title: From Email type: string from_label: description: A label representing the sender of this message readOnly: true title: From Label type: string id: description: A string that uniquely identifies this message readOnly: true title: ID type: string list_id: description: The list's web ID readOnly: true title: List ID type: integer message: description: The plain-text content of the message title: Message type: string read: description: Whether this message has been marked as read title: Read type: boolean subject: description: The subject of this message title: Subject type: string timestamp: description: The date and time the message was either sent or received in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string title: Conversation Message type: object application/problem+json: schema: description: An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array conversation_id: description: A string that identifies this message's conversation readOnly: true title: Conversation ID type: string from_email: description: A label representing the email of the sender of this message title: From Email type: string from_label: description: A label representing the sender of this message readOnly: true title: From Label type: string id: description: A string that uniquely identifies this message readOnly: true title: ID type: string list_id: description: The list's web ID readOnly: true title: List ID type: integer message: description: The plain-text content of the message title: Message type: string read: description: Whether this message has been marked as read title: Read type: boolean subject: description: The subject of this message title: Subject type: string timestamp: description: The date and time the message was either sent or received in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string title: Conversation Message type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get message tags: - conversations x-custom-config: methodNameCamel: getConversationMessage methodNameSnake: get_conversation_message "/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger": post: deprecated: false description: A step trigger in a Customer Journey. To use it, create a starting point or step from the Customer Journey builder in the app using the Customer Journeys API condition. We’ll provide a url during the process that includes the {journey_id} and {step_id}. You’ll then be able to use this endpoint to trigger the condition for the posted contact. operationId: postCustomerJourneysJourneysIdStepsIdActionsTrigger parameters: - description: The id for the Journey. in: path name: journey_id required: true schema: type: integer x-title: Journey ID - description: The id for the Step. in: path name: step_id required: true schema: type: integer x-title: Step ID requestBody: content: application/json: schema: description: Information about subscribers in a Customer Journey's audience. properties: email_address: description: The list member's email address. title: Email Address type: string required: - email_address title: Subscriber in Customer Journey's audience type: object required: true responses: "204": content: application/json: schema: description: Empty Response application/problem+json: schema: description: Empty Response description: An empty response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Customer Journeys API trigger for a contact tags: - customerJourneys x-custom-config: methodNameCamel: trigger methodNameSnake: trigger /ecommerce/orders: get: deprecated: false description: Get information about an account's orders. operationId: getEcommerceOrders parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: Restrict results to orders with a specific `campaign_id` value. in: query name: campaign_id required: false schema: type: string x-title: Campaign ID - description: Restrict results to orders with a specific `outreach_id` value. in: query name: outreach_id required: false schema: type: string x-title: Outreach ID - description: Restrict results to orders made by a specific customer. in: query name: customer_id required: false schema: type: string x-title: Customer ID - description: Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad. in: query name: has_outreach required: false schema: type: boolean x-title: Has Outreach responses: "200": content: application/json: schema: description: A collection of orders in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array orders: description: An array of objects, each representing an order resource. items: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object title: Orders type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Orders type: object application/problem+json: schema: description: A collection of orders in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array orders: description: An array of objects, each representing an order resource. items: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object title: Orders type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Orders type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List account orders tags: - ecommerce x-custom-config: methodNameCamel: orders methodNameSnake: orders /ecommerce/stores: get: deprecated: false description: Get information about all stores in the account. operationId: getEcommerceStores parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset responses: "200": content: application/json: schema: description: A collection of stores in the account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array stores: description: An array of objects, each representing a store. items: description: An individual store in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object automations: description: Details for the automations attached to this store. properties: abandoned_browse: description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedBrowse automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedBrowse automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Browse Automation type: object abandoned_cart: description: abandonedCart automation details. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedCart automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedCart automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Cart Automation type: object readOnly: true title: Automations type: object connected_site: description: The Connected Site associated with the store. properties: site_foreign_id: description: The unique identifier for the connected site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: readOnly: true title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js readOnly: true title: Script URL type: string readOnly: true title: Script type: object readOnly: true title: Connected Site type: object created_at: description: The date and time the store was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. The store domain must be unique within a user account. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store readOnly: true title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. example: 1a2df69511 readOnly: true title: List ID type: string list_is_active: description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string updated_at: description: The date and time the store was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Store type: object title: Stores type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: E-commerce Stores type: object application/problem+json: schema: description: A collection of stores in the account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array stores: description: An array of objects, each representing a store. items: description: An individual store in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object automations: description: Details for the automations attached to this store. properties: abandoned_browse: description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedBrowse automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedBrowse automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Browse Automation type: object abandoned_cart: description: abandonedCart automation details. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedCart automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedCart automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Cart Automation type: object readOnly: true title: Automations type: object connected_site: description: The Connected Site associated with the store. properties: site_foreign_id: description: The unique identifier for the connected site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: readOnly: true title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js readOnly: true title: Script URL type: string readOnly: true title: Script type: object readOnly: true title: Connected Site type: object created_at: description: The date and time the store was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. The store domain must be unique within a user account. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store readOnly: true title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. example: 1a2df69511 readOnly: true title: List ID type: string list_is_active: description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string updated_at: description: The date and time the store was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Store type: object title: Stores type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: E-commerce Stores type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List stores tags: - ecommerce x-custom-config: methodNameCamel: stores methodNameSnake: stores post: deprecated: false description: Add a new store to your Mailchimp account. operationId: postEcommerceStores requestBody: content: application/json: schema: description: An individual store in an account. properties: address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. This parameter is required for Connected Sites and Google Ads. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list associated with the store. The `list_id` for a specific store cannot change. example: 1a2df69511 title: List ID type: string money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string required: - id - list_id - name - currency_code title: E-commerce Store type: object required: true responses: "200": content: application/json: schema: description: An individual store in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object automations: description: Details for the automations attached to this store. properties: abandoned_browse: description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedBrowse automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedBrowse automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Browse Automation type: object abandoned_cart: description: abandonedCart automation details. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedCart automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedCart automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Cart Automation type: object readOnly: true title: Automations type: object connected_site: description: The Connected Site associated with the store. properties: site_foreign_id: description: The unique identifier for the connected site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: readOnly: true title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js readOnly: true title: Script URL type: string readOnly: true title: Script type: object readOnly: true title: Connected Site type: object created_at: description: The date and time the store was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. The store domain must be unique within a user account. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store readOnly: true title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. example: 1a2df69511 readOnly: true title: List ID type: string list_is_active: description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string updated_at: description: The date and time the store was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Store type: object application/problem+json: schema: description: An individual store in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object automations: description: Details for the automations attached to this store. properties: abandoned_browse: description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedBrowse automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedBrowse automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Browse Automation type: object abandoned_cart: description: abandonedCart automation details. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedCart automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedCart automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Cart Automation type: object readOnly: true title: Automations type: object connected_site: description: The Connected Site associated with the store. properties: site_foreign_id: description: The unique identifier for the connected site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: readOnly: true title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js readOnly: true title: Script URL type: string readOnly: true title: Script type: object readOnly: true title: Connected Site type: object created_at: description: The date and time the store was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. The store domain must be unique within a user account. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store readOnly: true title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. example: 1a2df69511 readOnly: true title: List ID type: string list_is_active: description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string updated_at: description: The date and time the store was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Store type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add store tags: - ecommerce x-custom-config: methodNameCamel: addStore methodNameSnake: add_store "/ecommerce/stores/{store_id}": delete: deprecated: false description: Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts. operationId: deleteEcommerceStoresId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID responses: "204": content: application/json: schema: description: Empty Response application/problem+json: schema: description: Empty Response description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete store tags: - ecommerce x-custom-config: methodNameCamel: deleteStore methodNameSnake: delete_store get: deprecated: false description: Get information about a specific store. operationId: getEcommerceStoresId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID responses: "200": content: application/json: schema: description: An individual store in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object automations: description: Details for the automations attached to this store. properties: abandoned_browse: description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedBrowse automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedBrowse automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Browse Automation type: object abandoned_cart: description: abandonedCart automation details. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedCart automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedCart automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Cart Automation type: object readOnly: true title: Automations type: object connected_site: description: The Connected Site associated with the store. properties: site_foreign_id: description: The unique identifier for the connected site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: readOnly: true title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js readOnly: true title: Script URL type: string readOnly: true title: Script type: object readOnly: true title: Connected Site type: object created_at: description: The date and time the store was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. The store domain must be unique within a user account. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store readOnly: true title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. example: 1a2df69511 readOnly: true title: List ID type: string list_is_active: description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string updated_at: description: The date and time the store was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Store type: object application/problem+json: schema: description: An individual store in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object automations: description: Details for the automations attached to this store. properties: abandoned_browse: description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedBrowse automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedBrowse automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Browse Automation type: object abandoned_cart: description: abandonedCart automation details. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedCart automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedCart automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Cart Automation type: object readOnly: true title: Automations type: object connected_site: description: The Connected Site associated with the store. properties: site_foreign_id: description: The unique identifier for the connected site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: readOnly: true title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js readOnly: true title: Script URL type: string readOnly: true title: Script type: object readOnly: true title: Connected Site type: object created_at: description: The date and time the store was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. The store domain must be unique within a user account. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store readOnly: true title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. example: 1a2df69511 readOnly: true title: List ID type: string list_is_active: description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string updated_at: description: The date and time the store was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Store type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get store info tags: - ecommerce x-custom-config: methodNameCamel: getStore methodNameSnake: get_store patch: deprecated: false description: Update a store. operationId: patchEcommerceStoresId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID requestBody: content: application/json: schema: description: An individual store in an account. properties: address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string title: E-commerce Store type: object required: true responses: "200": content: application/json: schema: description: An individual store in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object automations: description: Details for the automations attached to this store. properties: abandoned_browse: description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedBrowse automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedBrowse automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Browse Automation type: object abandoned_cart: description: abandonedCart automation details. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedCart automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedCart automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Cart Automation type: object readOnly: true title: Automations type: object connected_site: description: The Connected Site associated with the store. properties: site_foreign_id: description: The unique identifier for the connected site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: readOnly: true title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js readOnly: true title: Script URL type: string readOnly: true title: Script type: object readOnly: true title: Connected Site type: object created_at: description: The date and time the store was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. The store domain must be unique within a user account. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store readOnly: true title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. example: 1a2df69511 readOnly: true title: List ID type: string list_is_active: description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string updated_at: description: The date and time the store was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Store type: object application/problem+json: schema: description: An individual store in an account. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The store address. properties: address1: description: The store's mailing address. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the store's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the store is located in. example: Atlanta title: "City " type: string country: description: The store's country. example: United States title: Country Code type: string country_code: description: The two-letter code for to the store's country. example: US title: Country Code type: string latitude: description: The latitude of the store location. example: 45.427408 title: Latitude type: number longitude: description: The longitude of the store location. example: -75.68903 title: Longitude type: number postal_code: description: The store's postal or zip code. example: "30308" title: Postal Code type: string province: description: The store's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the store's province or state. example: GA title: Province Code type: string title: Address type: object automations: description: Details for the automations attached to this store. properties: abandoned_browse: description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedBrowse automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedBrowse automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Browse Automation type: object abandoned_cart: description: abandonedCart automation details. properties: id: description: Unique ID of automation parent campaign. example: 355a72bfc3 readOnly: true title: ID type: string is_supported: description: Whether this store supports the abandonedCart automation. example: false readOnly: true title: Is Supported type: boolean status: description: Status of the abandonedCart automation. enum: - save - sending - paused example: sending readOnly: true title: Status type: string readOnly: true title: Abandoned Cart Automation type: object readOnly: true title: Automations type: object connected_site: description: The Connected Site associated with the store. properties: site_foreign_id: description: The unique identifier for the connected site. example: a180c384d7db88b if created in-app, MC001 if created via API readOnly: true title: Connected Site Foreign ID type: string site_script: description: The script used to connect your site with Mailchimp. properties: fragment: description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: readOnly: true title: Script Fragment type: string url: description: The URL used for any integrations that offer built-in support for connected sites. example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js readOnly: true title: Script URL type: string readOnly: true title: Script type: object readOnly: true title: Connected Site type: object created_at: description: The date and time the store was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD title: Currency type: string domain: description: The store domain. The store domain must be unique within a user account. example: example.com title: Domain type: string email_address: description: The email address for the store. example: freddie@mailchimp.com title: Email Address type: string id: description: The unique identifier for the store. example: example_store readOnly: true title: Store Foreign ID type: string is_syncing: description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). title: Is Syncing type: boolean list_id: description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. example: 1a2df69511 readOnly: true title: List ID type: string list_is_active: description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean money_format: description: "The currency format for the store. For example: `$`, `£`, etc." example: $ title: Money Format type: string name: description: The name of the store. example: Freddie's Cat Hat Emporium title: Store Name type: string phone: description: The store phone number. example: 404-444-4444 title: Phone type: string platform: description: The e-commerce platform of the store. title: Platform type: string primary_locale: description: "The primary locale for the store. For example: `en`, `de`, etc." example: fr title: Primary Locale type: string timezone: description: The timezone for the store. example: Eastern title: Timezone type: string updated_at: description: The date and time the store was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Store type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update store tags: - ecommerce x-custom-config: methodNameCamel: updateStore methodNameSnake: update_store "/ecommerce/stores/{store_id}/carts": get: deprecated: false description: Get information about a store's carts. operationId: getEcommerceStoresIdCarts parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID responses: "200": content: application/json: schema: description: A collection of a store's carts. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array carts: description: An array of objects, each representing a cart. items: description: Information about a specific cart. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string created_at: description: The date and time the cart was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object id: description: A unique identifier for the cart. readOnly: true title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number updated_at: description: The date and time the cart was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Cart type: object title: E-commerce Store Carts type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Carts type: object application/problem+json: schema: description: A collection of a store's carts. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array carts: description: An array of objects, each representing a cart. items: description: Information about a specific cart. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string created_at: description: The date and time the cart was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object id: description: A unique identifier for the cart. readOnly: true title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number updated_at: description: The date and time the cart was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Cart type: object title: E-commerce Store Carts type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Carts type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List carts tags: - ecommerce x-custom-config: methodNameCamel: getStoreCarts methodNameSnake: get_store_carts post: deprecated: false description: Add a new cart to a store. operationId: postEcommerceStoresIdCarts parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID requestBody: content: application/json: schema: description: Information about a specific cart. properties: campaign_id: description: A string that uniquely identifies the campaign for a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body. properties: address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string email_address: description: The customer's email address. title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. Limited to 50 characters. maxLength: 50 title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean required: - id title: E-commerce Customer type: object id: description: A unique identifier for the cart. title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: id: description: A unique identifier for the cart line item. title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer required: - id - product_id - product_variant_id - quantity - price title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number required: - id - currency_code - customer - order_total - lines title: E-commerce Cart type: object required: true responses: "200": content: application/json: schema: description: Information about a specific cart. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string created_at: description: The date and time the cart was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object id: description: A unique identifier for the cart. readOnly: true title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number updated_at: description: The date and time the cart was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Cart type: object application/problem+json: schema: description: Information about a specific cart. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string created_at: description: The date and time the cart was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object id: description: A unique identifier for the cart. readOnly: true title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number updated_at: description: The date and time the cart was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Cart type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add cart tags: - ecommerce x-custom-config: methodNameCamel: addStoreCart methodNameSnake: add_store_cart "/ecommerce/stores/{store_id}/carts/{cart_id}": delete: deprecated: false description: Delete a cart. operationId: deleteEcommerceStoresIdCartsId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the cart. in: path name: cart_id required: true schema: type: string x-title: Cart ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete cart tags: - ecommerce x-custom-config: methodNameCamel: deleteStoreCart methodNameSnake: delete_store_cart get: deprecated: false description: Get information about a specific cart. operationId: getEcommerceStoresIdCartsId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the cart. in: path name: cart_id required: true schema: type: string x-title: Cart ID responses: "200": content: application/json: schema: description: Information about a specific cart. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string created_at: description: The date and time the cart was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object id: description: A unique identifier for the cart. readOnly: true title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number updated_at: description: The date and time the cart was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Cart type: object application/problem+json: schema: description: Information about a specific cart. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string created_at: description: The date and time the cart was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object id: description: A unique identifier for the cart. readOnly: true title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number updated_at: description: The date and time the cart was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Cart type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get cart info tags: - ecommerce x-custom-config: methodNameCamel: getStoreCart methodNameSnake: get_store_cart patch: deprecated: false description: Update a specific cart. operationId: patchEcommerceStoresIdCartsId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the cart. in: path name: cart_id required: true schema: type: string x-title: Cart ID requestBody: content: application/json: schema: description: Information about a specific cart. properties: campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string first_name: description: The customer's first name. title: First Name type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean title: E-commerce Customer type: object lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number title: E-commerce Cart type: object required: true responses: "200": content: application/json: schema: description: Information about a specific cart. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string created_at: description: The date and time the cart was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object id: description: A unique identifier for the cart. readOnly: true title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number updated_at: description: The date and time the cart was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Cart type: object application/problem+json: schema: description: Information about a specific cart. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array campaign_id: description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b title: Campaign ID type: string 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. title: Checkout URL type: string created_at: description: The date and time the cart was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the cart uses. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object id: description: A unique identifier for the cart. readOnly: true title: Cart Foreign ID type: string lines: description: An array of the cart's line items. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Cart Line Items type: array order_total: description: The order total for the cart. title: Order Total type: number tax_total: description: The total tax for the cart. title: Tax Total type: number updated_at: description: The date and time the cart was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Cart type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update cart tags: - ecommerce x-custom-config: methodNameCamel: updateStoreCart methodNameSnake: update_store_cart "/ecommerce/stores/{store_id}/carts/{cart_id}/lines": get: deprecated: false description: Get information about a cart's line items. operationId: getEcommerceStoresIdCartsIdLines parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the cart. in: path name: cart_id required: true schema: type: string x-title: Cart ID responses: "200": content: application/json: schema: description: A collection of a cart's line items. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array cart_id: description: The cart id. title: Cart ID type: string lines: description: An array of objects, each representing a cart's line item. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Ecommerce Cart Lines type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Cart Lines type: object application/problem+json: schema: description: A collection of a cart's line items. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array cart_id: description: The cart id. title: Cart ID type: string lines: description: An array of objects, each representing a cart's line item. items: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object title: Ecommerce Cart Lines type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Cart Lines type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List cart line items tags: - ecommerce x-custom-config: methodNameCamel: getAllCartLineItems methodNameSnake: get_all_cart_line_items post: deprecated: false description: Add a new line item to an existing cart. operationId: postEcommerceStoresIdCartsIdLines parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the cart. in: path name: cart_id required: true schema: type: string x-title: Cart ID requestBody: content: application/json: schema: description: Information about a specific cart line item. properties: id: description: A unique identifier for the cart line item. title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer required: - id - product_id - product_variant_id - quantity - price title: E-commerce Cart Line Item type: object required: true responses: "200": content: application/json: schema: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object application/problem+json: schema: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add cart line item tags: - ecommerce x-custom-config: methodNameCamel: addCartLineItem methodNameSnake: add_cart_line_item "/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}": delete: deprecated: false description: Delete a specific cart line item. operationId: deleteEcommerceStoresIdCartsLinesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the cart. in: path name: cart_id required: true schema: type: string x-title: Cart ID - description: The id for the line item of a cart. in: path name: line_id required: true schema: type: string x-title: Cart Line ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete cart line item tags: - ecommerce x-custom-config: methodNameCamel: deleteCartLineItem methodNameSnake: delete_cart_line_item get: deprecated: false description: Get information about a specific cart line item. operationId: getEcommerceStoresIdCartsIdLinesId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the cart. in: path name: cart_id required: true schema: type: string x-title: Cart ID - description: The id for the line item of a cart. in: path name: line_id required: true schema: type: string x-title: Cart Line ID responses: "200": content: application/json: schema: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object application/problem+json: schema: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get cart line item tags: - ecommerce x-custom-config: methodNameCamel: getCartLineItem methodNameSnake: get_cart_line_item patch: deprecated: false description: Update a specific cart line item. operationId: patchEcommerceStoresIdCartsIdLinesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the cart. in: path name: cart_id required: true schema: type: string x-title: Cart ID - description: The id for the line item of a cart. in: path name: line_id required: true schema: type: string x-title: Cart Line ID requestBody: content: application/json: schema: description: Information about a specific cart line item. properties: price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object required: true responses: "200": content: application/json: schema: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object application/problem+json: schema: description: Information about a specific cart line item. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the cart line item. readOnly: true title: Cart Line Item Foreign ID type: string price: description: The price of a cart line item. title: Price type: number product_id: description: A unique identifier for the product associated with the cart line item. title: Cart Line Product Foreign ID type: string product_title: description: The name of the product for the cart line item. readOnly: true title: Cart Line Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with the cart line item. title: Cart Line Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for the cart line item. readOnly: true title: Cart Line Product Variant Title type: string quantity: description: The quantity of a cart line item. title: Quantity type: integer title: E-commerce Cart Line Item type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update cart line item tags: - ecommerce x-custom-config: methodNameCamel: updateCartLineItem methodNameSnake: update_cart_line_item "/ecommerce/stores/{store_id}/customers": get: deprecated: false description: Get information about a store's customers. operationId: getEcommerceStoresIdCustomers parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: Restrict the response to customers with the email address. in: query name: email_address required: false schema: type: string x-title: Customer Email Address responses: "200": content: application/json: schema: description: A collection of the store's customers. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array customers: description: An array of objects, each representing a customer of a store. items: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object title: Customers type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Customers type: object application/problem+json: schema: description: A collection of the store's customers. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array customers: description: An array of objects, each representing a customer of a store. items: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object title: Customers type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Customers type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List customers tags: - ecommerce x-custom-config: methodNameCamel: getAllStoreCustomers methodNameSnake: get_all_store_customers post: deprecated: false description: Add a new customer to a store. operationId: postEcommerceStoresIdCustomers parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID requestBody: content: application/json: schema: description: Information about a specific customer. properties: address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string email_address: description: The customer's email address. title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. Limited to 50 characters. maxLength: 50 title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean required: - id - email_address - opt_in_status title: E-commerce Customer type: object required: true responses: "200": content: application/json: schema: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object application/problem+json: schema: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add customer tags: - ecommerce x-custom-config: methodNameCamel: addStoreCustomer methodNameSnake: add_store_customer "/ecommerce/stores/{store_id}/customers/{customer_id}": delete: deprecated: false description: Delete a customer from a store. operationId: deleteEcommerceStoresIdCustomersId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the customer of a store. in: path name: customer_id required: true schema: type: string x-title: Customer ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete customer tags: - ecommerce x-custom-config: methodNameCamel: deleteStoreCustomer methodNameSnake: delete_store_customer get: deprecated: false description: Get information about a specific customer. operationId: getEcommerceStoresIdCustomersId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the customer of a store. in: path name: customer_id required: true schema: type: string x-title: Customer ID responses: "200": content: application/json: schema: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object application/problem+json: schema: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get customer info tags: - ecommerce x-custom-config: methodNameCamel: getStoreCustomer methodNameSnake: get_store_customer patch: deprecated: false description: Update a customer. operationId: patchEcommerceStoresIdCustomersId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the customer of a store. in: path name: customer_id required: true schema: type: string x-title: Customer ID requestBody: content: application/json: schema: description: Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string first_name: description: The customer's first name. title: First Name type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean title: E-commerce Customer type: object required: true responses: "200": content: application/json: schema: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object application/problem+json: schema: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update customer tags: - ecommerce x-custom-config: methodNameCamel: updateStoreCustomer methodNameSnake: update_store_customer put: deprecated: false description: Add or update a customer. operationId: putEcommerceStoresIdCustomersId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the customer of a store. in: path name: customer_id required: true schema: type: string x-title: Customer ID requestBody: content: application/json: schema: description: Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string email_address: description: The customer's email address. title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. Limited to 50 characters. maxLength: 50 title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean required: - id - email_address - opt_in_status title: E-commerce Customer type: object required: true responses: "200": content: application/json: schema: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object application/problem+json: schema: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add or update customer tags: - ecommerce x-custom-config: methodNameCamel: setStoreCustomer methodNameSnake: set_store_customer "/ecommerce/stores/{store_id}/orders": get: deprecated: false description: Get information about a store's orders. operationId: getEcommerceStoresIdOrders parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: Restrict results to orders made by a specific customer. in: query name: customer_id required: false schema: type: string x-title: Customer ID - description: Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad. in: query name: has_outreach required: false schema: type: boolean x-title: Has Outreach - description: Restrict results to orders with a specific `campaign_id` value. in: query name: campaign_id required: false schema: type: string x-title: Campaign ID - description: Restrict results to orders with a specific `outreach_id` value. in: query name: outreach_id required: false schema: type: string x-title: Outreach ID responses: "200": content: application/json: schema: description: A collection of orders in a store. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array orders: description: An array of objects, each representing an order in a store. items: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object title: Orders type: array store_id: description: The unique identifier for the store. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Orders type: object application/problem+json: schema: description: A collection of orders in a store. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array orders: description: An array of objects, each representing an order in a store. items: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object title: Orders type: array store_id: description: The unique identifier for the store. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Orders type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List orders tags: - ecommerce x-custom-config: methodNameCamel: getStoreOrders methodNameSnake: get_store_orders post: deprecated: false description: Add a new order to a store. operationId: postEcommerceStoresIdOrders parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID requestBody: content: application/json: schema: description: Information about a specific order. properties: billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with the billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign for an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: 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 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body. properties: address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string email_address: description: The customer's email address. title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. Limited to 50 characters. maxLength: 50 title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean required: - id title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: discount: description: The total discount amount applied to this line item. title: Discount type: number id: description: A unique identifier for the order line item. title: Order Line Item Foreign ID type: string price: description: The price of an order line item. title: Price type: number product_id: description: A unique identifier for the product associated with the order line item. title: Order Line Item Product Foreign ID type: string product_variant_id: description: A unique identifier for the product variant associated with the order line item. title: Order Line Item Product Variant Foreign ID type: string quantity: description: The quantity of an order line item. title: Quantity type: integer required: - id - product_id - product_variant_id - quantity - price title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The total for the order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string required: - code - type - amount_discounted type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with the shipping address. title: Company type: string country: description: The country in the shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the shipping address. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number tax_total: description: The tax total for the order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string required: - id - customer - currency_code - order_total - lines title: E-commerce Order type: object required: true responses: "200": content: application/json: schema: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object application/problem+json: schema: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add order tags: - ecommerce x-custom-config: methodNameCamel: addStoreOrder methodNameSnake: add_store_order "/ecommerce/stores/{store_id}/orders/{order_id}": delete: deprecated: false description: Delete an order. operationId: deleteEcommerceStoresIdOrdersId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the order in a store. in: path name: order_id required: true schema: type: string x-title: Order ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete order tags: - ecommerce x-custom-config: methodNameCamel: deleteOrder methodNameSnake: delete_order get: deprecated: false description: Get information about a specific order. operationId: getEcommerceStoresIdOrdersId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the order in a store. in: path name: order_id required: true schema: type: string x-title: Order ID responses: "200": content: application/json: schema: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object application/problem+json: schema: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get order info tags: - ecommerce x-custom-config: methodNameCamel: getOrder methodNameSnake: get_order patch: deprecated: false description: Update a specific order. operationId: patchEcommerceStoresIdOrdersId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the order in a store. in: path name: order_id required: true schema: type: string x-title: Order ID requestBody: content: application/json: schema: description: Information about a specific order. properties: billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: 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 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string first_name: description: The customer's first name. title: First Name type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: discount: description: The total discount amount applied to this line item. title: Discount type: number price: description: The price of an order line item. title: Price type: number product_id: description: A unique identifier for the product associated with the order line item. title: Order Line Item Product Foreign ID type: string product_variant_id: description: A unique identifier for the product variant associated with the order line item. title: Order Line Item Product Variant Foreign ID type: string quantity: description: The quantity of an order line item. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: "The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided." items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string required: - code - type - amount_discounted type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object required: true responses: "200": content: application/json: schema: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object application/problem+json: schema: description: Information about a specific order. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array billing_address: description: The billing address for the order. properties: address1: description: The billing address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the billing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the billing address. example: Atlanta title: "City " type: string company: description: The company associated with the billing address. title: Company type: string country: description: The country in the billing address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the billing address. example: US title: Country Code type: string latitude: description: The latitude for the billing address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the billing address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's billing address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the billing address. example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the billing address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the billing address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state in the billing address. example: GA title: Province Code type: string title: Billing Address type: object campaign_id: description: A string that uniquely identifies the campaign associated with an order. example: 839488a60b title: Campaign ID type: string cancelled_at_foreign: description: The date and time the order was cancelled in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Cancel Time type: string currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. title: Currency Code type: string customer: description: Information about a specific customer. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array address: description: The customer's address. properties: address1: description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the customer's mailing address. example: Suite 5000 title: Address Field 2 type: string city: description: The city the customer is located in. example: Atlanta title: "City " type: string country: description: The customer's country. example: United States title: Country Code type: string country_code: description: The two-letter code for the customer's country. example: US title: Country Code type: string postal_code: description: The customer's postal or zip code. example: "30308" title: Postal Code type: string province: description: The customer's state name or normalized province. example: Georgia title: Province type: string province_code: description: The two-letter code for the customer's province or state. example: GA title: Province Code type: string title: Address type: object company: description: The customer's company. title: Company type: string created_at: description: The date and time the customer was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string email_address: description: The customer's email address. readOnly: true title: Email Address type: string first_name: description: The customer's first name. title: First Name type: string id: description: A unique identifier for the customer. readOnly: true title: Customer Foreign ID type: string last_name: description: The customer's last name. title: Last Name type: string 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). title: Opt-in Status type: boolean orders_count: description: The customer's total order count. example: 4 readOnly: true title: Orders Count type: integer total_spent: description: The total amount the customer has spent. example: 100 readOnly: true title: Total Spent type: number updated_at: description: The date and time the customer was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string title: E-commerce Customer type: object discount_total: description: The total amount of the discounts to be applied to the price of the order. title: Discount Total type: number financial_status: description: The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). title: Financial Status type: string 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). title: Fulfillment Status type: string id: description: A unique identifier for the order. readOnly: true title: Order Foreign ID type: string landing_site: description: The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc title: Landing Site type: string lines: description: An array of the order's line items. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Order Line Items type: array order_total: description: The order total associated with an order. title: Order Total type: number order_url: description: The URL for the order. title: Order URL type: string outreach: description: The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: description: A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b title: Outreach ID type: string name: description: The name for the outreach. example: Freddie's Jokes readOnly: true title: Outreach name type: string published_time: description: The date and time the Outreach was published in ISO 8601 format. example: 2017-06-06T13:56:12+00:00 format: date-time readOnly: true title: Outreach published time type: string type: description: The type of the outreach. example: regular readOnly: true title: Outreach type type: string title: Outreach type: object processed_at_foreign: description: The date and time the order was processed in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Processed Time type: string promos: description: The promo codes applied on the order items: properties: 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 title: Amount Discounted type: number code: description: The Promo Code title: Code type: string type: description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage title: Type type: string type: object title: Promos type: array shipping_address: description: The shipping address for the order. properties: address1: description: The shipping address for the order. example: 675 Ponce de Leon Ave NE title: Address Field 1 type: string address2: description: An additional field for the shipping address. example: Suite 5000 title: Address Field 2 type: string city: description: The city in the order's shipping address. example: Atlanta title: "City " type: string company: description: The company associated with an order's shipping address. title: Company type: string country: description: The country in the order's shipping address. example: United States title: Country Code type: string country_code: description: The two-letter code for the country in the shipping address. example: US title: Country Code type: string latitude: description: The latitude for the shipping address location. example: 45.427408 title: Latitude type: number longitude: description: The longitude for the shipping address location. example: -75.68903 title: Longitude type: number name: description: The name associated with an order's shipping address. example: Freddie Chimpenheimer title: Name type: string phone: description: The phone number for the order's shipping address example: "8675309" title: Phone Number type: string postal_code: description: The postal or zip code in the order's shipping address. example: "30308" title: Postal Code type: string province: description: The state or normalized province in the order's shipping address. example: Georgia title: Province type: string province_code: description: The two-letter code for the province or state the order's shipping address is located in. example: GA title: Province Code type: string title: Shipping Address type: object shipping_total: description: The shipping total for the order. title: Shipping Total type: number store_id: description: The unique identifier for the store. readOnly: true title: Store Foreign ID type: string tax_total: description: The tax total associated with an order. title: Tax Total type: number tracking_carrier: description: The tracking carrier associated with the order. title: Tracking carrier type: string tracking_code: description: The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. enum: - prec title: Tracking Code type: string tracking_number: description: The tracking number associated with the order. title: Tracking number type: string tracking_url: description: The tracking URL associated with the order. title: Tracking URL type: string updated_at_foreign: description: The date and time the order was updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Update Time type: string title: E-commerce Order type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update order tags: - ecommerce x-custom-config: methodNameCamel: updateOrder methodNameSnake: update_order "/ecommerce/stores/{store_id}/orders/{order_id}/lines": get: deprecated: false description: Get information about an order's line items. operationId: getEcommerceStoresIdOrdersIdLines parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the order in a store. in: path name: order_id required: true schema: type: string x-title: Order ID responses: "200": content: application/json: schema: description: A collection of an order's line items. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array lines: description: An array of objects, each representing an order's line item. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Ecommerce Order Lines type: array order_id: description: The order id. title: Order ID type: string store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Order Lines type: object application/problem+json: schema: description: A collection of an order's line items. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array lines: description: An array of objects, each representing an order's line item. items: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object title: Ecommerce Order Lines type: array order_id: description: The order id. title: Order ID type: string store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Order Lines type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List order line items tags: - ecommerce x-custom-config: methodNameCamel: getAllOrderLineItems methodNameSnake: get_all_order_line_items post: deprecated: false description: Add a new line item to an existing order. operationId: postEcommerceStoresIdOrdersIdLines parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the order in a store. in: path name: order_id required: true schema: type: string x-title: Order ID requestBody: content: application/json: schema: description: Information about a specific order line. properties: discount: description: The total discount amount applied to this line item. title: Discount type: number id: description: A unique identifier for the order line item. title: Order Line Item Foreign ID type: string price: description: The price of an order line item. title: Price type: number product_id: description: A unique identifier for the product associated with the order line item. title: Order Line Item Product Foreign ID type: string product_variant_id: description: A unique identifier for the product variant associated with the order line item. title: Order Line Item Product Variant Foreign ID type: string quantity: description: The quantity of an order line item. title: Quantity type: integer required: - id - product_id - product_variant_id - quantity - price title: E-commerce Order Line Item type: object required: true responses: "200": content: application/json: schema: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object application/problem+json: schema: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add order line item tags: - ecommerce x-custom-config: methodNameCamel: addOrderLineItem methodNameSnake: add_order_line_item "/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}": delete: deprecated: false description: Delete a specific order line item. operationId: deleteEcommerceStoresIdOrdersIdLinesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the order in a store. in: path name: order_id required: true schema: type: string x-title: Order ID - description: The id for the line item of an order. in: path name: line_id required: true schema: type: string x-title: Order Line ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete order line item tags: - ecommerce x-custom-config: methodNameCamel: deleteOrderLineItem methodNameSnake: delete_order_line_item get: deprecated: false description: Get information about a specific order line item. operationId: getEcommerceStoresIdOrdersIdLinesId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the order in a store. in: path name: order_id required: true schema: type: string x-title: Order ID - description: The id for the line item of an order. in: path name: line_id required: true schema: type: string x-title: Order Line ID responses: "200": content: application/json: schema: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object application/problem+json: schema: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get order line item tags: - ecommerce x-custom-config: methodNameCamel: getOrderLineItem methodNameSnake: get_order_line_item patch: deprecated: false description: Update a specific order line item. operationId: patchEcommerceStoresIdOrdersIdLinesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the order in a store. in: path name: order_id required: true schema: type: string x-title: Order ID - description: The id for the line item of an order. in: path name: line_id required: true schema: type: string x-title: Order Line ID requestBody: content: application/json: schema: description: Information about a specific order line. properties: discount: description: The total discount amount applied to this line item. title: Discount type: number price: description: The price of an order line item. title: Price type: number product_id: description: A unique identifier for the product associated with the order line item. title: Order Line Item Product Foreign ID type: string product_variant_id: description: A unique identifier for the product variant associated with the order line item. title: Order Line Item Product Variant Foreign ID type: string quantity: description: The quantity of an order line item. title: Quantity type: integer title: E-commerce Order Line Item type: object required: true responses: "200": content: application/json: schema: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object application/problem+json: schema: description: Information about a specific order line. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array discount: description: The total discount amount applied to a line item. title: Discount type: number id: description: A unique identifier for an order line item. readOnly: true title: Order Line Item Foreign ID type: string image_url: description: The image URL for a product. readOnly: true title: Product Image URL type: string price: description: The order line item price. title: Price type: number product_id: description: A unique identifier for the product associated with an order line item. title: Order Line Item Product Foreign ID type: string product_title: description: The name of the product for an order line item. readOnly: true title: Order Line Item Product Title type: string product_variant_id: description: A unique identifier for the product variant associated with an order line item. title: Order Line Item Product Variant Foreign ID type: string product_variant_title: description: The name of the product variant for an order line item. readOnly: true title: Order Line Item Product Variant Title type: string quantity: description: The order line item quantity. title: Quantity type: integer title: E-commerce Order Line Item type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update order line item tags: - ecommerce x-custom-config: methodNameCamel: updateOrderLineItem methodNameSnake: update_order_line_item "/ecommerce/stores/{store_id}/products": get: deprecated: false description: Get information about a store's products. operationId: getEcommerceStoresIdProducts parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID responses: "200": content: application/json: schema: description: A collection of a store's products. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array products: description: An array of objects, each representing a store product. items: description: Information about a specific product. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array currency_code: description: The currency code readOnly: true title: Currency Code type: string description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. readOnly: true title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string variants: description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object title: Products type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Products type: object application/problem+json: schema: description: A collection of a store's products. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array products: description: An array of objects, each representing a store product. items: description: Information about a specific product. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array currency_code: description: The currency code readOnly: true title: Currency Code type: string description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. readOnly: true title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string variants: description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object title: Products type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Products type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List product tags: - ecommerce x-custom-config: methodNameCamel: getAllStoreProducts methodNameSnake: get_all_store_products post: deprecated: false description: Add a new product to a store. operationId: postEcommerceStoresIdProducts parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID requestBody: content: application/json: schema: description: Information about a specific product. properties: description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array required: - id - url title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string 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: description: Information about a specific product variant. properties: backorders: description: The backorders of a product variant. title: Backorders type: string id: description: A unique identifier for the product variant. title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string required: - id - title title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string required: - id - title - variants title: E-commerce Product type: object required: true responses: "200": content: application/json: schema: description: Information about a specific product. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array currency_code: description: The currency code readOnly: true title: Currency Code type: string description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. readOnly: true title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string variants: description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object application/problem+json: schema: description: Information about a specific product. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array currency_code: description: The currency code readOnly: true title: Currency Code type: string description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. readOnly: true title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string variants: description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add product tags: - ecommerce x-custom-config: methodNameCamel: addStoreProduct methodNameSnake: add_store_product "/ecommerce/stores/{store_id}/products/{product_id}": delete: deprecated: false description: Delete a product. operationId: deleteEcommerceStoresIdProductsId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete product tags: - ecommerce x-custom-config: methodNameCamel: deleteStoreProduct methodNameSnake: delete_store_product get: deprecated: false description: Get information about a specific product. operationId: getEcommerceStoresIdProductsId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID responses: "200": content: application/json: schema: description: Information about a specific product. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array currency_code: description: The currency code readOnly: true title: Currency Code type: string description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. readOnly: true title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string variants: description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object application/problem+json: schema: description: Information about a specific product. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array currency_code: description: The currency code readOnly: true title: Currency Code type: string description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. readOnly: true title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string variants: description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get product info tags: - ecommerce x-custom-config: methodNameCamel: getStoreProduct methodNameSnake: get_store_product patch: deprecated: false description: Update a specific product. operationId: patchEcommerceStoresIdProductsId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID requestBody: content: application/json: schema: description: Information about a specific product. properties: description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string 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: description: Information about a specific product variant. properties: backorders: description: The backorders of a product variant. title: Backorders type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object required: true responses: "200": content: application/json: schema: description: Information about a specific product. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array currency_code: description: The currency code readOnly: true title: Currency Code type: string description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. readOnly: true title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string variants: description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object application/problem+json: schema: description: Information about a specific product. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array currency_code: description: The currency code readOnly: true title: Currency Code type: string description: description: The description of a product. example: This is a cat hat. title: Description type: string handle: description: The handle of a product. example: cat-hat title: Handle type: string id: description: A unique identifier for the product. readOnly: true title: Product Foreign ID type: string image_url: description: The image URL for a product. title: Product Image URL type: string images: description: An array of the product's images. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Product Images type: array published_at_foreign: description: The date and time the product was published in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time title: Foreign Publish Time type: string title: description: The title of a product. example: Cat Hat title: Title type: string type: description: The type of product. example: Accessories title: Type type: string url: description: The URL for a product. title: Product URL type: string variants: description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Product Variants type: array vendor: description: The vendor for a product. title: Vendor type: string title: E-commerce Product type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update product tags: - ecommerce x-custom-config: methodNameCamel: updateStoreProduct methodNameSnake: update_store_product "/ecommerce/stores/{store_id}/products/{product_id}/images": get: deprecated: false description: Get information about a product's images. operationId: getEcommerceStoresIdProductsIdImages parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID responses: "200": content: application/json: schema: description: A collection of a product's images. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array images: description: An array of objects, each representing a product image resource. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Ecommerce Product Images type: array product_id: description: The product id. title: Product ID type: string store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Ecommerce Product Images type: object application/problem+json: schema: description: A collection of a product's images. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array images: description: An array of objects, each representing a product image resource. items: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object title: Ecommerce Product Images type: array product_id: description: The product id. title: Product ID type: string store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Ecommerce Product Images type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List product images tags: - ecommerce x-custom-config: methodNameCamel: getProductImages methodNameSnake: get_product_images post: deprecated: false description: Add a new image to the product. operationId: postEcommerceStoresIdProductsIdImages parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID requestBody: content: application/json: schema: description: Information about a specific product image. properties: id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array required: - id - url title: E-commerce Product Image type: object required: true responses: "200": content: application/json: schema: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object application/problem+json: schema: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add product image tags: - ecommerce x-custom-config: methodNameCamel: addProductImage methodNameSnake: add_product_image "/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}": delete: deprecated: false description: Delete a product image. operationId: deleteEcommerceStoresIdProductsIdImagesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID - description: The id for the product image. in: path name: image_id required: true schema: type: string x-title: Product Image ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete product image tags: - ecommerce x-custom-config: methodNameCamel: deleteProductImage methodNameSnake: delete_product_image get: deprecated: false description: Get information about a specific product image. operationId: getEcommerceStoresIdProductsIdImagesId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID - description: The id for the product image. in: path name: image_id required: true schema: type: string x-title: Product Image ID responses: "200": content: application/json: schema: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object application/problem+json: schema: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get product image info tags: - ecommerce x-custom-config: methodNameCamel: getProductImage methodNameSnake: get_product_image patch: deprecated: false description: Update a product image. operationId: patchEcommerceStoresIdProductsIdImagesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID - description: The id for the product image. in: path name: image_id required: true schema: type: string x-title: Product Image ID requestBody: content: application/json: schema: description: Information about a specific product image. properties: id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object required: true responses: "200": content: application/json: schema: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object application/problem+json: schema: description: Information about a specific product image. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array id: description: A unique identifier for the product image. title: Image Foreign ID type: string url: description: The URL for a product image. title: URL type: string variant_ids: description: The list of product variants using the image. items: type: string title: Product Variants type: array title: E-commerce Product Image type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update product image tags: - ecommerce x-custom-config: methodNameCamel: updateProductImage methodNameSnake: update_product_image "/ecommerce/stores/{store_id}/products/{product_id}/variants": get: deprecated: false description: Get information about a product's variants. operationId: getEcommerceStoresIdProductsIdVariants parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID responses: "200": content: application/json: schema: description: A collection of a product's variants. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array product_id: description: The product id. title: Product ID type: string store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer variants: description: An array of objects, each representing a product's variants. items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Ecommerce Product Variants type: array title: Ecommerce Product Variants type: object application/problem+json: schema: description: A collection of a product's variants. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array product_id: description: The product id. title: Product ID type: string store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer variants: description: An array of objects, each representing a product's variants. items: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object title: Ecommerce Product Variants type: array title: Ecommerce Product Variants type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List product variants tags: - ecommerce x-custom-config: methodNameCamel: getProductVariants methodNameSnake: get_product_variants post: deprecated: false description: Add a new variant to the product. operationId: postEcommerceStoresIdProductsIdVariants parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID requestBody: $ref: "#/components/requestBodies/postEcommerceStoresIdProductsIdVariantsBody" responses: "200": content: application/json: schema: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object application/problem+json: schema: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add product variant tags: - ecommerce x-custom-config: methodNameCamel: addProductVariants methodNameSnake: add_product_variants "/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}": delete: deprecated: false description: Delete a product variant. operationId: deleteEcommerceStoresIdProductsIdVariantsId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID - description: The id for the product variant. in: path name: variant_id required: true schema: type: string x-title: Product Variant ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete product variant tags: - ecommerce x-custom-config: methodNameCamel: deleteProductVariant methodNameSnake: delete_product_variant get: deprecated: false description: Get information about a specific product variant. operationId: getEcommerceStoresIdProductsIdVariantsId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID - description: The id for the product variant. in: path name: variant_id required: true schema: type: string x-title: Product Variant ID responses: "200": content: application/json: schema: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object application/problem+json: schema: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get product variant info tags: - ecommerce x-custom-config: methodNameCamel: getProductVariant methodNameSnake: get_product_variant patch: deprecated: false description: Update a product variant. operationId: patchEcommerceStoresIdProductsIdVariantsId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID - description: The id for the product variant. in: path name: variant_id required: true schema: type: string x-title: Product Variant ID requestBody: content: application/json: schema: description: Information about a specific product variant. properties: backorders: description: The backorders of a product variant. title: Backorders type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object required: true responses: "200": content: application/json: schema: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object application/problem+json: schema: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update product variant tags: - ecommerce x-custom-config: methodNameCamel: updateProductVariant methodNameSnake: update_product_variant put: deprecated: false description: Add or update a product variant. operationId: putEcommerceStoresIdProductsIdVariantsId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the product of a store. in: path name: product_id required: true schema: type: string x-title: Product ID - description: The id for the product variant. in: path name: variant_id required: true schema: type: string x-title: Product Variant ID requestBody: $ref: "#/components/requestBodies/postEcommerceStoresIdProductsIdVariantsBody" responses: "200": content: application/json: schema: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object application/problem+json: schema: description: Information about a specific product variant. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array backorders: description: The backorders of a product variant. title: Backorders type: string created_at: description: The date and time the product was created in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Creation Time type: string id: description: A unique identifier for the product variant. readOnly: true title: Product Variant Foreign ID type: string image_url: description: The image URL for a product variant. title: Image URL type: string inventory_quantity: description: The inventory quantity of a product variant. title: Inventory Quantity type: integer price: description: The price of a product variant. title: Price type: number sku: description: The stock keeping unit (SKU) of a product variant. title: SKU type: string title: description: The title of a product variant. example: Cat Hat title: Title type: string updated_at: description: The date and time the product was last updated in ISO 8601 format. example: 2015-07-15T19:28:00+00:00 format: date-time readOnly: true title: Update Time type: string url: description: The URL for a product variant. title: URL type: string visibility: description: The visibility of a product variant. title: Visibility type: string title: E-commerce Product Variant type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add or update product variant tags: - ecommerce x-custom-config: methodNameCamel: addProductVariant methodNameSnake: add_product_variant "/ecommerce/stores/{store_id}/promo-rules": get: deprecated: false description: Get information about a store's promo rules. operationId: getEcommerceStoresIdPromorules parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID responses: "200": content: application/json: schema: description: A collection of the store's promo rules. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array promo_rules: description: An array of objects, each representing promo rules defined for a store. items: description: Information about an Ecommerce Store's specific Promo Rule properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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. readOnly: true title: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object title: Promo Rules type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Promo Rules type: object application/problem+json: schema: description: A collection of the store's promo rules. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array promo_rules: description: An array of objects, each representing promo rules defined for a store. items: description: Information about an Ecommerce Store's specific Promo Rule properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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. readOnly: true title: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object title: Promo Rules type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Promo Rules type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List promo rules tags: - ecommerce x-custom-config: methodNameCamel: listPromoRules methodNameSnake: list_promo_rules post: deprecated: false description: Add a new promo rule to a store. operationId: postEcommerceStoresIdPromorules parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID requestBody: content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Rule. properties: amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string required: - id - description - amount - type - target title: E-commerce Promo Rule type: object required: true responses: "200": content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Rule properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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. readOnly: true title: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object application/problem+json: schema: description: Information about an Ecommerce Store's specific Promo Rule properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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. readOnly: true title: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add promo rule tags: - ecommerce x-custom-config: methodNameCamel: addPromoRules methodNameSnake: add_promo_rules "/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}": delete: deprecated: false description: Delete a promo rule from a store. operationId: deleteEcommerceStoresIdPromorulesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the promo rule of a store. in: path name: promo_rule_id required: true schema: type: string x-title: Promo Rule ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete promo rule tags: - ecommerce x-custom-config: methodNameCamel: deletePromoRule methodNameSnake: delete_promo_rule get: deprecated: false description: Get information about a specific promo rule. operationId: getEcommerceStoresIdPromorulesId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the promo rule of a store. in: path name: promo_rule_id required: true schema: type: string x-title: Promo Rule ID responses: "200": content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Rule properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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. readOnly: true title: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object application/problem+json: schema: description: Information about an Ecommerce Store's specific Promo Rule properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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. readOnly: true title: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get promo rule tags: - ecommerce x-custom-config: methodNameCamel: getPromoRule methodNameSnake: get_promo_rule patch: deprecated: false description: Update a promo rule. operationId: patchEcommerceStoresIdPromorulesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the promo rule of a store. in: path name: promo_rule_id required: true schema: type: string x-title: Promo Rule ID requestBody: content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Rule. properties: amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object required: true responses: "200": content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Rule properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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. readOnly: true title: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object application/problem+json: schema: description: Information about an Ecommerce Store's specific Promo Rule properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array amount: 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 format: float title: Amount type: number created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string description: description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! title: Description type: string enabled: description: Whether the promo rule is currently enabled. example: "true" title: Enabled type: boolean ends_at: description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. format: Promo date-time title: End Time type: string 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. readOnly: true title: Promo Rule Foreign ID type: string starts_at: description: The date and time when the promotion is in effect in ISO 8601 format. format: date-time title: Promo Start Time type: string target: description: The target that the discount applies to. enum: - per_item - total - shipping title: Target type: string 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 title: Title type: string type: description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage title: Type type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string title: E-commerce Promo Rule type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update promo rule tags: - ecommerce x-custom-config: methodNameCamel: updatePromoRule methodNameSnake: update_promo_rule "/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes": get: deprecated: false description: Get information about a store's promo codes. operationId: getEcommerceStoresIdPromocodes parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: The id for the promo rule of a store. in: path name: promo_rule_id required: true schema: type: string x-title: Promo Rule ID - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID responses: "200": content: application/json: schema: description: A collection of the store's promo codes. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array promo_codes: description: An array of objects, each representing promo codes defined for a store. items: description: Information about an Ecommerce Store's specific Promo Code properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo Code. readOnly: true title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object title: Promo Codes type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Promo Codes type: object application/problem+json: schema: description: A collection of the store's promo codes. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array promo_codes: description: An array of objects, each representing promo codes defined for a store. items: description: Information about an Ecommerce Store's specific Promo Code properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo Code. readOnly: true title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object title: Promo Codes type: array store_id: description: The store id. title: Store ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Promo Codes type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: List promo codes tags: - ecommerce x-custom-config: methodNameCamel: getPromoCodes methodNameSnake: get_promo_codes post: deprecated: false description: Add a new promo code to a store. operationId: postEcommerceStoresIdPromocodes parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the promo rule of a store. in: path name: promo_rule_id required: true schema: type: string x-title: Promo Rule ID requestBody: content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Code. properties: code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50. title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer required: - id - code - redemption_url title: E-commerce Promo Code type: object required: true responses: "200": content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Code properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo Code. readOnly: true title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object application/problem+json: schema: description: Information about an Ecommerce Store's specific Promo Code properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo Code. readOnly: true title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Add promo code tags: - ecommerce x-custom-config: methodNameCamel: addPromoCode methodNameSnake: add_promo_code "/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}": delete: deprecated: false description: Delete a promo code from a store. operationId: deleteEcommerceStoresIdPromocodesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the promo rule of a store. in: path name: promo_rule_id required: true schema: type: string x-title: Promo Rule ID - description: The id for the promo code of a store. in: path name: promo_code_id required: true schema: type: string x-title: Promo Code ID responses: "204": description: Empty Response default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Delete promo code tags: - ecommerce x-custom-config: methodNameCamel: deletePromoCode methodNameSnake: delete_promo_code get: deprecated: false description: Get information about a specific promo code. operationId: getEcommerceStoresIdPromocodesId parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the promo rule of a store. in: path name: promo_rule_id required: true schema: type: string x-title: Promo Rule ID - description: The id for the promo code of a store. in: path name: promo_code_id required: true schema: type: string x-title: Promo Code ID responses: "200": content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Code properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo Code. readOnly: true title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object application/problem+json: schema: description: Information about an Ecommerce Store's specific Promo Code properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo Code. readOnly: true title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Get promo code tags: - ecommerce x-custom-config: methodNameCamel: getPromoCode methodNameSnake: get_promo_code patch: deprecated: false description: Update a promo code. operationId: patchEcommerceStoresIdPromocodesId parameters: - description: The store id. in: path name: store_id required: true schema: type: string x-title: Store ID - description: The id for the promo rule of a store. in: path name: promo_rule_id required: true schema: type: string x-title: Promo Rule ID - description: The id for the promo code of a store. in: path name: promo_code_id required: true schema: type: string x-title: Promo Code ID requestBody: content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Code. properties: code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object required: true responses: "200": content: application/json: schema: description: Information about an Ecommerce Store's specific Promo Code properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo Code. readOnly: true title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object application/problem+json: schema: description: Information about an Ecommerce Store's specific Promo Code properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array code: description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale title: Promo Code type: string created_at_foreign: description: The date and time the promotion was created in ISO 8601 format. format: date-time title: Foreign Create Time type: string enabled: description: Whether the promo code is currently enabled. example: "true" title: Enabled type: boolean id: description: A unique identifier for the promo Code. readOnly: true title: Promo Code Foreign ID type: string redemption_url: description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url title: Redemption Url type: string updated_at_foreign: description: The date and time the promotion was updated in ISO 8601 format. format: date-time title: Foreign Update Time type: string usage_count: description: Number of times promo code has been used. title: Promo Code Usage Count type: integer title: E-commerce Promo Code type: object description: "" default: content: application/json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object application/problem+json: schema: description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. properties: detail: description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. title: Error Message type: string instance: description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 title: Instance ID type: string status: description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 title: HTTP Status Code type: integer title: description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found title: Error Title type: string type: description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: Problem Type type: string required: - type - title - status - detail - instance title: Problem Detail Document type: object description: An error generated by the Mailchimp API. summary: Update promo code tags: - ecommerce x-custom-config: methodNameCamel: updatePromoCode methodNameSnake: update_promo_code /facebook-ads: get: description: Get list of Facebook ads. operationId: getAllFacebookAds parameters: - description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. explode: false in: query name: fields required: false schema: items: type: string type: array style: form x-title: Fields - description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. explode: false in: query name: exclude_fields required: false schema: items: type: string type: array style: form x-title: Exclude Fields - description: The number of records to return. Default value is 10. Maximum value is 1000 in: query name: count required: false schema: default: 10 maximum: 1000 type: integer x-title: Count - description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. in: query name: offset required: false schema: default: 0 type: integer x-title: Offset - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - created_at - updated_at - end_time type: string x-title: Sort By Field - description: Determines the order direction for sorted results. in: query name: sort_dir required: false schema: enum: - ASC - DESC type: string x-title: Sort Direction responses: "200": content: application/json: schema: description: Contains an array of facebook ads. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array facebook_ads: items: allOf: - properties: canceled_at: description: The date and time the outreach was canceled in ISO 8601 format. format: date-time title: Canceled At type: string create_time: description: The date and time the outreach was created in ISO 8601 format. format: date-time title: Create Time type: string has_segment: description: If this outreach targets a segment of your audience. title: Has Segment type: boolean id: description: Unique ID of an Outreach. title: ID type: string name: description: Title or name of an Outreach. title: Name type: string published_time: description: The date and time the outreach was (or will be) published in ISO 8601 format. format: date-time title: Publish Time type: string recipients: description: High level audience information for who the outreach targets. properties: list_id: description: The unique list id. title: List ID type: string list_is_active: description: The status of the list used, namely if it's deleted or disabled. readOnly: true title: List Status type: boolean list_name: description: The name of the list. readOnly: true title: List Name type: string recipient_count: description: Count of the recipients on the associated list. Formatted as an integer. readOnly: true title: Recipient Count type: integer segment_opts: 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: conditions: 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: discriminator: propertyName: condition_type type: string oneOf: - description: Segment by interaction with a specific campaign. properties: condition_type: enum: - Aim type: string x-value: Aim field: description: Segment by interaction with a specific campaign. enum: - aim example: aim title: Segment Field type: string op: 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." enum: - open - click - sent - noopen - noclick - nosent example: open title: Segment Operator type: string value: 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 title: Segment Data type: string title: Aim Segment type: object - description: Segment by interaction with an Automation workflow. properties: condition_type: enum: - Automation type: string x-value: Automation field: description: Segment by interaction with an Automation workflow. enum: - automation example: automation title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The web id for the automation workflow to segment against. example: "2135217" title: Segment Data type: string required: - field - op - value title: Automation Segment type: object - description: Segment by poll activity. properties: condition_type: enum: - CampaignPoll type: string x-value: CampaignPoll field: description: Segment by poll activity. enum: - poll example: poll title: Segment Field type: string op: description: Members have/have not interacted with a specific poll in a Mailchimp email. enum: - member - notmember example: member title: Segment Operator type: string value: description: The id for the poll. example: 409 title: Segment Operator type: number required: - field - op - value title: Poll Activity Segment type: object - description: Segment by interaction with a campaign via Conversations. properties: condition_type: enum: - Conversation type: string x-value: Conversation field: description: Segment by interaction with a campaign via Conversations. enum: - conversation example: conversation title: Segment Field type: string op: description: "The status of a member's interaction with a conversation. One of the following: has replied or has not replied." enum: - member - notmember example: member title: Segment Operator type: string value: 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 title: Segment Data type: string required: - field - op - value title: Conversation Segment type: object - description: Segment by a specific date field. properties: condition_type: enum: - Date type: string x-value: Date extra: 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 title: Segment Extra Value type: string 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." enum: - timestamp_opt - info_changed - ecomm_date example: timestamp_opt title: Segment Field type: string op: description: "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank." enum: - greater - less - is - not - blank - blank_not - within - notwithin example: greater title: Segment Operator type: string value: description: "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." example: date title: Segment Data type: string required: - field - op - value title: Date Segment type: object - description: Segment by use of a particular email client. properties: condition_type: enum: - EmailClient type: string x-value: EmailClient field: description: Segment by use of a particular email client. enum: - email_client example: email_client title: Segment Field type: string op: description: The operation to determine whether we select clients that match the value, or clients that do not match the value. enum: - client_is - client_not example: client_is title: Segment Operator type: string value: description: The name of the email client. example: Gmail title: Segment Data type: string required: - field - op - value title: Email Client Segment type: object - description: Segment by language. properties: condition_type: enum: - Language type: string x-value: Language field: description: Segmenting based off of a subscriber's language. enum: - language example: language title: Segment Field type: string op: description: Whether the member's language is or is not set to a specific language. enum: - is - not example: is title: Segment Operator type: string value: description: A two-letter language identifier. example: en title: Segment Data type: string required: - field - op - value title: Language Segment type: object - description: Segment by member rating. properties: condition_type: enum: - MemberRating type: string x-value: MemberRating field: description: Segment by member rating. enum: - rating example: rating title: Segment Field type: string op: 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. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: The star rating number to segment against. example: 4 title: Segment Operator type: number required: - field - op - value title: Member Rating Segment type: object - description: Segment by signup source. properties: condition_type: enum: - SignupSource title: Type type: string x-value: SignupSource field: enum: - source example: source title: Segment Field type: string op: description: Whether the member's signup source was/was not a particular value. enum: - source_is - source_not example: source_is title: Segment Operator type: string value: description: The signup source. example: List Import title: Segment Data type: string required: - field - condition_type - op title: Signup Source Segment type: object - description: Segment by interaction with a SurveyMonkey survey. properties: condition_type: enum: - SurveyMonkey type: string x-value: SurveyMonkey field: description: Segment by interaction with a SurveyMonkey survey. enum: - survey_monkey example: survey_monkey title: Segment Field type: string op: 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." enum: - started - completed - not_started - not_completed example: started title: Segment Operator type: string value: description: The unique ID of the survey monkey survey. example: "32179586" title: Survey ID type: string required: - field - op - value title: Survey Monkey Segment type: object - description: Segment by VIP status. properties: condition_type: enum: - VIP type: string x-value: VIP field: description: Segment by VIP status. enum: - gmonkey example: gmonkey title: Segment Field type: string op: description: Whether the member is or is not marked as VIP. enum: - member - notmember example: member title: Segment Operator type: string required: - field - op title: VIP Segment type: object - description: Segment by an interest group merge field. properties: condition_type: enum: - Interests type: string x-value: Interests field: description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 title: Segment Field type: string op: description: Whether the member is a part of one, all, or none of the groups. enum: - interestcontains - interestcontainsall - interestnotcontains example: interestcontains title: Segment Operator type: string value: description: An array containing strings, each representing a group id. items: example: - "44401" - "44405" - "44409" type: string title: Segment Value type: array title: Interests Segment type: object - description: Segment by purchases in specific items or categories. properties: condition_type: enum: - EcommCategory type: string x-value: EcommCategory field: description: Segment by purchases in specific items or categories. enum: - ecomm_cat - ecomm_prod example: ecomm_cat title: Segment Field type: string op: 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. enum: - is - not - contains - notcontain - starts - ends example: is title: Segment Operator type: string value: description: The ecommerce category/item information. example: Product title: Segment Data type: string title: Ecommerce Category Segment type: object - description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. properties: condition_type: enum: - EcommNumber type: string x-value: EcommNumber field: description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord example: ecomm_orders title: Segment Field type: string op: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. enum: - is - not - greater - less example: greater title: Segment Operator type: string value: description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 title: Segment Operator type: number required: - field - op - value title: Ecommerce Number Segment type: object - description: Segment by whether someone has purchased anything. properties: condition_type: enum: - EcommPurchased type: string x-value: EcommPurchased field: description: Segment by whether someone has purchased anything. enum: - ecomm_purchased example: ecomm_purchased title: Segment Field type: string op: description: Members who have have ('member') or have not ('notmember') purchased. enum: - member - notmember example: member title: Segment Operator type: string title: Ecommerce Purchased Segment type: object - description: Segment by amount spent on a single order or across all orders. properties: condition_type: enum: - EcommSpent type: string x-value: EcommSpent field: description: Segment by amount spent on a single order or across all orders. enum: - ecomm_spent_one - ecomm_spent_all example: ecomm_spent_one title: Segment Field type: string op: description: Members who have spent 'more' or 'less' than then specified value. enum: - greater - less example: greater title: Segment Operator type: string value: description: The total amount a member spent. example: 42 title: Segment Data type: integer title: Ecommerce Spent Segment type: object - description: Segment by purchases from a specific store. properties: condition_type: enum: - EcommStore type: string x-value: EcommStore field: description: Segment by purchases from a specific store. enum: - ecomm_store example: ecomm_store title: Segment Field type: string op: description: Members who have or have not purchased from a specific store. enum: - is - not example: is title: Segment Operator type: string value: description: The store id to segment against. example: "289" title: Segment Operator type: string title: Ecommerce Purchased Store Segment type: object - description: Segment by Goal activity. properties: condition_type: enum: - GoalActivity type: string x-value: GoalActivity field: description: Segment by Goal activity. enum: - goal example: goal title: Segment Field type: string op: description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. enum: - is - goal_not - contains - goal_notcontain - starts - ends example: is title: Segment Operator type: string value: description: The URL to check Goal activity against. title: Segment Value type: string required: - field - op - value title: Goal Activity Segment type: object - description: Segment by most recent interaction with a website. properties: condition_type: enum: - GoalTimestamp type: string x-value: GoalTimestamp field: description: Segment by most recent interaction with a website. enum: - goal_last_visited example: goal_last_visited title: Segment Field type: string op: description: Whether the website activity happened after, before, or at a given timestamp. enum: - greater - less - is example: greater title: Segment Operator type: string value: description: The date to check Goal activity against. example: 2015-07-20 19:45:21 title: Segment Value type: string required: - field - op - value title: Goal Timestamp Segment type: object - description: Segment by similar subscribers. properties: condition_type: enum: - FuzzySegment type: string x-value: FuzzySegment field: description: Segment by similar subscribers. enum: - fuzzy_segment example: fuzzy_segment title: Segment Field type: string op: description: Members who are/are not apart of a 'similar subscribers' segment. enum: - fuzzy_is - fuzzy_not example: fuzzy_is title: Segment Operator type: string value: description: The id for the 'similar subscribers' segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Similar Subscribers Segment Member Segment type: object - description: Segment by a given static segment. properties: condition_type: enum: - StaticSegment type: string x-value: StaticSegment field: description: Segment by a given static segment. enum: - static_segment example: static_segment title: Segment Field type: string op: description: Members who are/are not apart of a static segment. enum: - static_is - static_not example: static_is title: Segment Operator type: string value: description: The id for the static segment. example: 48433 title: Segment Operator type: number required: - field - op - value title: Static Segment Member Segment type: object - description: Segment by a specific country or US state. properties: condition_type: enum: - IPGeoCountryState type: string x-value: IPGeoCountryState field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a specific country or US state. enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate example: ipgeocountry title: Segment Operator type: string value: description: The two-letter country code or US state abbreviation. example: US title: Segment Data type: string required: - field - op - value title: Location-Based Segment type: object - description: Segment by a specific geographic region. properties: addr: description: The address of the target location. example: Atlanta, GA, USA title: Segment Location Address type: string condition_type: enum: - IPGeoIn type: string x-value: IPGeoIn field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string lat: description: The latitude of the target location. example: "33.7489954" title: Segment Location Latitude type: string lng: description: The longitude of the target location. example: "-84.3879824" title: Segment Location Longitude type: string op: description: Segment members who are within a specific geographic region. enum: - ipgeoin - ipgeonotin example: ipgeoin title: Segment Operator type: string value: description: The radius of the target location. example: 42 title: Segment Data type: integer required: - field - op - value - addr - lat - lng title: Geolocation Segment type: object - description: Segment by a specific US ZIP code. properties: condition_type: enum: - IPGeoInZip type: string x-value: IPGeoInZip extra: description: The zip code to segment against. example: 30318 title: Extra Data type: integer field: description: Segmenting subscribers who are within a specific location. enum: - ipgeo example: ipgeo title: Segment Field type: string op: description: Segment members who are within a s