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 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 title: Recipients type: object report_summary: description: High level reporting stats for an outreach. properties: click_rate: type: number clicks: type: integer conversion_rate: type: number ecommerce: properties: average_order_revenue: type: number currency_code: type: string total_revenue: type: number type: object engagements: type: integer impressions: type: number open_rate: type: number opens: type: integer reach: type: integer subscriber_clicks: type: integer subscribes: type: integer total_sent: type: integer unique_opens: type: integer unique_visits: type: integer visits: type: integer title: Report Summary type: object show_report: description: "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." title: Show Report type: boolean start_time: description: The date and time the outreach was started in ISO 8601 format. format: date-time title: Start Time type: string status: description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished title: Outreach Status type: string thumbnail: description: The URL of the thumbnail for this outreach. title: Thumbnail type: string type: description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey title: Outreach Type type: string updated_at: description: The date and time the outreach was last updated in ISO 8601 format. format: date-time title: Updated At type: string web_id: description: The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. title: Web ID type: integer type: object - properties: email_source_name: title: "Ad: Email Source Name" type: string end_time: description: The date and time the ad was ended in ISO 8601 format. format: date-time title: "Ad: End Time" type: string needs_attention: description: If the ad has a problem and needs attention. title: "Ad: Needs Attention" type: boolean paused_at: description: The date and time the ad was paused in ISO 8601 format. format: date-time title: "Ad: Paused At" type: string was_canceled_by_facebook: title: "Ad: Was Canceled By Facebook" type: boolean type: object - description: A facebook ad. properties: audience: description: Audience settings properties: email_source: properties: is_segment: description: Is the source reference a segment type: boolean list_name: description: Associated list name to the source type: string name: description: Email source name type: string segment_type: description: Segment type if this source is tied to a segment type: string type: description: Type of the email source type: string type: object include_source_in_target: description: To include list contacts as part of audience type: boolean lookalike_country_code: description: To find similar audience in given country type: string source_type: description: List or Facebook based audience enum: - facebook - list type: string targeting_specs: properties: gender: enum: - 0 - 1 - 2 type: integer interests: items: properties: name: type: string type: object type: array locations: properties: cities: items: type: string type: array countries: items: type: string type: array regions: items: type: string type: array zips: items: type: string type: array type: object max_age: type: integer min_age: type: integer type: object type: description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience type: string type: object budget: properties: currency_code: description: Currency code example: USD type: string duration: description: Duration of the ad in seconds example: 86400 type: integer total_amount: description: Total budget of the ad example: 500 type: number type: object channel: description: Channel settings properties: fb_placement_audience: description: Is this for facebook audience example: false type: boolean fb_placement_feed: description: Is this for facebook feed example: true type: boolean ig_placement_feed: description: Is this for instagram feed example: false type: boolean type: object content: properties: attachments: items: properties: call_to_action: type: string description: type: string image_url: type: string link_url: type: string name: type: string type: object type: array call_to_action: type: string description: type: string image_url: type: string link_url: type: string message: type: string title: type: string type: object feedback: description: Check if this ad is connected to a facebook page properties: audience: description: Feedback regarding the audience of this Ad. type: string budget: description: Feedback regarding the budget of this Ad. type: string compliance: description: Feedback regarding the compliance of this Ad. type: string content: description: Feedback regarding the content of this Ad. type: string type: object has_audience: description: Check if this ad has audience setup type: boolean has_content: description: Check if this ad has content type: boolean is_connected: description: Check if this ad is connected to a facebook page type: boolean site: description: Connected Site properties: id: description: The ID of this connected site. example: 43 type: integer name: description: The name of the connected site example: My Connected Site type: string url: description: The URL for this connected site. example: www.example.com type: string type: object type: object - properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array type: object 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: 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 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 title: Recipients type: object report_summary: description: High level reporting stats for an outreach. properties: click_rate: type: number clicks: type: integer conversion_rate: type: number ecommerce: properties: average_order_revenue: type: number currency_code: type: string total_revenue: type: number type: object engagements: type: integer impressions: type: number open_rate: type: number opens: type: integer reach: type: integer subscriber_clicks: type: integer subscribes: type: integer total_sent: type: integer unique_opens: type: integer unique_visits: type: integer visits: type: integer title: Report Summary type: object show_report: description: "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." title: Show Report type: boolean start_time: description: The date and time the outreach was started in ISO 8601 format. format: date-time title: Start Time type: string status: description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished title: Outreach Status type: string thumbnail: description: The URL of the thumbnail for this outreach. title: Thumbnail type: string type: description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey title: Outreach Type type: string updated_at: description: The date and time the outreach was last updated in ISO 8601 format. format: date-time title: Updated At type: string web_id: description: The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. title: Web ID type: integer type: object - properties: email_source_name: title: "Ad: Email Source Name" type: string end_time: description: The date and time the ad was ended in ISO 8601 format. format: date-time title: "Ad: End Time" type: string needs_attention: description: If the ad has a problem and needs attention. title: "Ad: Needs Attention" type: boolean paused_at: description: The date and time the ad was paused in ISO 8601 format. format: date-time title: "Ad: Paused At" type: string was_canceled_by_facebook: title: "Ad: Was Canceled By Facebook" type: boolean type: object - description: A facebook ad. properties: audience: description: Audience settings properties: email_source: properties: is_segment: description: Is the source reference a segment type: boolean list_name: description: Associated list name to the source type: string name: description: Email source name type: string segment_type: description: Segment type if this source is tied to a segment type: string type: description: Type of the email source type: string type: object include_source_in_target: description: To include list contacts as part of audience type: boolean lookalike_country_code: description: To find similar audience in given country type: string source_type: description: List or Facebook based audience enum: - facebook - list type: string targeting_specs: properties: gender: enum: - 0 - 1 - 2 type: integer interests: items: properties: name: type: string type: object type: array locations: properties: cities: items: type: string type: array countries: items: type: string type: array regions: items: type: string type: array zips: items: type: string type: array type: object max_age: type: integer min_age: type: integer type: object type: description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience type: string type: object budget: properties: currency_code: description: Currency code example: USD type: string duration: description: Duration of the ad in seconds example: 86400 type: integer total_amount: description: Total budget of the ad example: 500 type: number type: object channel: description: Channel settings properties: fb_placement_audience: description: Is this for facebook audience example: false type: boolean fb_placement_feed: description: Is this for facebook feed example: true type: boolean ig_placement_feed: description: Is this for instagram feed example: false type: boolean type: object content: properties: attachments: items: properties: call_to_action: type: string description: type: string image_url: type: string link_url: type: string name: type: string type: object type: array call_to_action: type: string description: type: string image_url: type: string link_url: type: string message: type: string title: type: string type: object feedback: description: Check if this ad is connected to a facebook page properties: audience: description: Feedback regarding the audience of this Ad. type: string budget: description: Feedback regarding the budget of this Ad. type: string compliance: description: Feedback regarding the compliance of this Ad. type: string content: description: Feedback regarding the content of this Ad. type: string type: object has_audience: description: Check if this ad has audience setup type: boolean has_content: description: Check if this ad has content type: boolean is_connected: description: Check if this ad is connected to a facebook page type: boolean site: description: Connected Site properties: id: description: The ID of this connected site. example: 43 type: integer name: description: The name of the connected site example: My Connected Site type: string url: description: The URL for this connected site. example: www.example.com type: string type: object type: object - properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array type: object 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: List of Facebook Ad Instances 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 facebook ads tags: - facebookAds x-custom-config: methodNameCamel: list methodNameSnake: list "/facebook-ads/{outreach_id}": get: description: Get details of a Facebook ad. operationId: getFacebookAdsId 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: The outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID - 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: 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 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 title: Recipients type: object report_summary: description: High level reporting stats for an outreach. properties: click_rate: type: number clicks: type: integer conversion_rate: type: number ecommerce: properties: average_order_revenue: type: number currency_code: type: string total_revenue: type: number type: object engagements: type: integer impressions: type: number open_rate: type: number opens: type: integer reach: type: integer subscriber_clicks: type: integer subscribes: type: integer total_sent: type: integer unique_opens: type: integer unique_visits: type: integer visits: type: integer title: Report Summary type: object show_report: description: "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." title: Show Report type: boolean start_time: description: The date and time the outreach was started in ISO 8601 format. format: date-time title: Start Time type: string status: description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished title: Outreach Status type: string thumbnail: description: The URL of the thumbnail for this outreach. title: Thumbnail type: string type: description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey title: Outreach Type type: string updated_at: description: The date and time the outreach was last updated in ISO 8601 format. format: date-time title: Updated At type: string web_id: description: The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. title: Web ID type: integer type: object - properties: email_source_name: title: "Ad: Email Source Name" type: string end_time: description: The date and time the ad was ended in ISO 8601 format. format: date-time title: "Ad: End Time" type: string needs_attention: description: If the ad has a problem and needs attention. title: "Ad: Needs Attention" type: boolean paused_at: description: The date and time the ad was paused in ISO 8601 format. format: date-time title: "Ad: Paused At" type: string was_canceled_by_facebook: title: "Ad: Was Canceled By Facebook" type: boolean type: object - description: A facebook ad. properties: audience: description: Audience settings properties: email_source: properties: is_segment: description: Is the source reference a segment type: boolean list_name: description: Associated list name to the source type: string name: description: Email source name type: string segment_type: description: Segment type if this source is tied to a segment type: string type: description: Type of the email source type: string type: object include_source_in_target: description: To include list contacts as part of audience type: boolean lookalike_country_code: description: To find similar audience in given country type: string source_type: description: List or Facebook based audience enum: - facebook - list type: string targeting_specs: properties: gender: enum: - 0 - 1 - 2 type: integer interests: items: properties: name: type: string type: object type: array locations: properties: cities: items: type: string type: array countries: items: type: string type: array regions: items: type: string type: array zips: items: type: string type: array type: object max_age: type: integer min_age: type: integer type: object type: description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience type: string type: object budget: properties: currency_code: description: Currency code example: USD type: string duration: description: Duration of the ad in seconds example: 86400 type: integer total_amount: description: Total budget of the ad example: 500 type: number type: object channel: description: Channel settings properties: fb_placement_audience: description: Is this for facebook audience example: false type: boolean fb_placement_feed: description: Is this for facebook feed example: true type: boolean ig_placement_feed: description: Is this for instagram feed example: false type: boolean type: object content: properties: attachments: items: properties: call_to_action: type: string description: type: string image_url: type: string link_url: type: string name: type: string type: object type: array call_to_action: type: string description: type: string image_url: type: string link_url: type: string message: type: string title: type: string type: object feedback: description: Check if this ad is connected to a facebook page properties: audience: description: Feedback regarding the audience of this Ad. type: string budget: description: Feedback regarding the budget of this Ad. type: string compliance: description: Feedback regarding the compliance of this Ad. type: string content: description: Feedback regarding the content of this Ad. type: string type: object has_audience: description: Check if this ad has audience setup type: boolean has_content: description: Check if this ad has content type: boolean is_connected: description: Check if this ad is connected to a facebook page type: boolean site: description: Connected Site properties: id: description: The ID of this connected site. example: 43 type: integer name: description: The name of the connected site example: My Connected Site type: string url: description: The URL for this connected site. example: www.example.com type: string type: object type: object - properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array type: object application/problem+json: schema: 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 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 title: Recipients type: object report_summary: description: High level reporting stats for an outreach. properties: click_rate: type: number clicks: type: integer conversion_rate: type: number ecommerce: properties: average_order_revenue: type: number currency_code: type: string total_revenue: type: number type: object engagements: type: integer impressions: type: number open_rate: type: number opens: type: integer reach: type: integer subscriber_clicks: type: integer subscribes: type: integer total_sent: type: integer unique_opens: type: integer unique_visits: type: integer visits: type: integer title: Report Summary type: object show_report: description: "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." title: Show Report type: boolean start_time: description: The date and time the outreach was started in ISO 8601 format. format: date-time title: Start Time type: string status: description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished title: Outreach Status type: string thumbnail: description: The URL of the thumbnail for this outreach. title: Thumbnail type: string type: description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey title: Outreach Type type: string updated_at: description: The date and time the outreach was last updated in ISO 8601 format. format: date-time title: Updated At type: string web_id: description: The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. title: Web ID type: integer type: object - properties: email_source_name: title: "Ad: Email Source Name" type: string end_time: description: The date and time the ad was ended in ISO 8601 format. format: date-time title: "Ad: End Time" type: string needs_attention: description: If the ad has a problem and needs attention. title: "Ad: Needs Attention" type: boolean paused_at: description: The date and time the ad was paused in ISO 8601 format. format: date-time title: "Ad: Paused At" type: string was_canceled_by_facebook: title: "Ad: Was Canceled By Facebook" type: boolean type: object - description: A facebook ad. properties: audience: description: Audience settings properties: email_source: properties: is_segment: description: Is the source reference a segment type: boolean list_name: description: Associated list name to the source type: string name: description: Email source name type: string segment_type: description: Segment type if this source is tied to a segment type: string type: description: Type of the email source type: string type: object include_source_in_target: description: To include list contacts as part of audience type: boolean lookalike_country_code: description: To find similar audience in given country type: string source_type: description: List or Facebook based audience enum: - facebook - list type: string targeting_specs: properties: gender: enum: - 0 - 1 - 2 type: integer interests: items: properties: name: type: string type: object type: array locations: properties: cities: items: type: string type: array countries: items: type: string type: array regions: items: type: string type: array zips: items: type: string type: array type: object max_age: type: integer min_age: type: integer type: object type: description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience type: string type: object budget: properties: currency_code: description: Currency code example: USD type: string duration: description: Duration of the ad in seconds example: 86400 type: integer total_amount: description: Total budget of the ad example: 500 type: number type: object channel: description: Channel settings properties: fb_placement_audience: description: Is this for facebook audience example: false type: boolean fb_placement_feed: description: Is this for facebook feed example: true type: boolean ig_placement_feed: description: Is this for instagram feed example: false type: boolean type: object content: properties: attachments: items: properties: call_to_action: type: string description: type: string image_url: type: string link_url: type: string name: type: string type: object type: array call_to_action: type: string description: type: string image_url: type: string link_url: type: string message: type: string title: type: string type: object feedback: description: Check if this ad is connected to a facebook page properties: audience: description: Feedback regarding the audience of this Ad. type: string budget: description: Feedback regarding the budget of this Ad. type: string compliance: description: Feedback regarding the compliance of this Ad. type: string content: description: Feedback regarding the content of this Ad. type: string type: object has_audience: description: Check if this ad has audience setup type: boolean has_content: description: Check if this ad has content type: boolean is_connected: description: Check if this ad is connected to a facebook page type: boolean site: description: Connected Site properties: id: description: The ID of this connected site. example: 43 type: integer name: description: The name of the connected site example: My Connected Site type: string url: description: The URL for this connected site. example: www.example.com type: string type: object type: object - properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array type: object description: Facebook Ad Instance 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 facebook ad info tags: - facebookAds x-custom-config: methodNameCamel: getAd methodNameSnake: get_ad /file-manager/files: get: deprecated: false description: Get a list of available images and files stored in the File Manager for the account. operationId: getFileManagerFiles 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 file type for the File Manager file. in: query name: type required: false schema: type: string x-title: File Type - description: The Mailchimp account user who created the File Manager file. in: query name: created_by required: false schema: type: string x-title: Created By - description: "Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_created_at required: false schema: type: string x-title: Before Created At - description: "Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_created_at required: false schema: type: string x-title: Since Created At - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - added_date - name - size 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: A list of available images and files stored in the File Manager for 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 files: description: " A list of files and images in an account." items: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File type: object title: Files type: array total_file_size: description: The total size of all File Manager files in bytes. readOnly: true title: Total File Size type: number total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: File Manager type: object application/problem+json: schema: description: A list of available images and files stored in the File Manager for 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 files: description: " A list of files and images in an account." items: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File type: object title: Files type: array total_file_size: description: The total size of all File Manager files in bytes. readOnly: true title: Total File Size type: number total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: File Manager 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 stored files tags: - fileManager x-custom-config: methodNameCamel: files methodNameSnake: files post: deprecated: false description: Upload a new image or file to the File Manager. operationId: postFileManagerFiles requestBody: content: application/json: schema: description: An individual file listed in the File Manager. properties: file_data: description: The base64-encoded contents of the file. title: File Data type: string folder_id: description: The id of the folder. title: Folder ID type: integer name: description: The name of the file. title: File Name type: string required: - name - file_data title: Gallery File type: object required: true responses: "200": content: application/json: schema: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File type: object application/problem+json: schema: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File 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 file tags: - fileManager x-custom-config: methodNameCamel: upload methodNameSnake: upload "/file-manager/files/{file_id}": delete: deprecated: false description: Remove a specific file from the File Manager. operationId: deleteFileManagerFilesId parameters: - description: The unique id for the File Manager file. in: path name: file_id required: true schema: type: string x-title: File 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 file tags: - fileManager x-custom-config: methodNameCamel: deleteFile methodNameSnake: delete_file get: deprecated: false description: Get information about a specific file in the File Manager. operationId: getFileManagerFilesId 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 File Manager file. in: path name: file_id required: true schema: type: string x-title: File ID responses: "200": content: application/json: schema: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File type: object application/problem+json: schema: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File 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 file tags: - fileManager x-custom-config: methodNameCamel: getFile methodNameSnake: get_file patch: deprecated: false description: Update a file in the File Manager. operationId: patchFileManagerFilesId parameters: - description: The unique id for the File Manager file. in: path name: file_id required: true schema: type: string x-title: File ID requestBody: content: application/json: schema: description: An individual file listed in the File Manager. properties: folder_id: description: The id of the folder. Setting `folder_id` to `0` will remove a file from its current folder. title: Folder ID type: integer name: description: The name of the file. title: File Name type: string title: Gallery File type: object required: true responses: "200": content: application/json: schema: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File type: object application/problem+json: schema: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File 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 file tags: - fileManager x-custom-config: methodNameCamel: updateFile methodNameSnake: update_file /file-manager/folders: get: deprecated: false description: Get a list of all folders in the File Manager. operationId: getFileManagerFolders 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 Mailchimp account user who created the File Manager file. in: query name: created_by required: false schema: type: string x-title: Created By - description: "Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_created_at required: false schema: type: string x-title: Before Created At - description: "Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_created_at required: false schema: type: string x-title: Since Created At responses: "200": content: application/json: schema: description: A list of all folders in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: A list of all folders in the File Manager. items: description: An individual folder listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that created the folder. readOnly: true title: Created By type: string file_count: description: The number of files in the folder. readOnly: true title: File Count type: integer id: description: The unique id for the folder. readOnly: true title: Folder ID type: integer name: description: The name of the folder. title: Folder Name type: string title: Gallery Folder type: object title: File Manager 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: File Manager Folders type: object application/problem+json: schema: description: A list of all folders in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: A list of all folders in the File Manager. items: description: An individual folder listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that created the folder. readOnly: true title: Created By type: string file_count: description: The number of files in the folder. readOnly: true title: File Count type: integer id: description: The unique id for the folder. readOnly: true title: Folder ID type: integer name: description: The name of the folder. title: Folder Name type: string title: Gallery Folder type: object title: File Manager 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: File Manager 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 folders tags: - fileManager x-custom-config: methodNameCamel: listFolders methodNameSnake: list_folders post: deprecated: false description: Create a new folder in the File Manager. operationId: postFileManagerFolders requestBody: $ref: "#/components/requestBodies/postFileManagerFoldersBody" responses: "200": content: application/json: schema: description: An individual folder listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that created the folder. readOnly: true title: Created By type: string file_count: description: The number of files in the folder. readOnly: true title: File Count type: integer id: description: The unique id for the folder. readOnly: true title: Folder ID type: integer name: description: The name of the folder. title: Folder Name type: string title: Gallery Folder type: object application/problem+json: schema: description: An individual folder listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that created the folder. readOnly: true title: Created By type: string file_count: description: The number of files in the folder. readOnly: true title: File Count type: integer id: description: The unique id for the folder. readOnly: true title: Folder ID type: integer name: description: The name of the folder. title: Folder Name type: string title: Gallery 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 folder tags: - fileManager x-custom-config: methodNameCamel: createFolder methodNameSnake: create_folder "/file-manager/folders/{folder_id}": delete: deprecated: false description: Delete a specific folder in the File Manager. operationId: deleteFileManagerFoldersId parameters: - description: The unique id for the File Manager folder. in: path name: folder_id required: true schema: type: string x-title: Folder 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 folder tags: - fileManager x-custom-config: methodNameCamel: deleteFolder methodNameSnake: delete_folder get: deprecated: false description: Get information about a specific folder in the File Manager. operationId: getFileManagerFoldersId 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 File Manager folder. in: path name: folder_id required: true schema: type: string x-title: Folder ID responses: "200": content: application/json: schema: description: An individual folder listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that created the folder. readOnly: true title: Created By type: string file_count: description: The number of files in the folder. readOnly: true title: File Count type: integer id: description: The unique id for the folder. readOnly: true title: Folder ID type: integer name: description: The name of the folder. title: Folder Name type: string title: Gallery Folder type: object application/problem+json: schema: description: An individual folder listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that created the folder. readOnly: true title: Created By type: string file_count: description: The number of files in the folder. readOnly: true title: File Count type: integer id: description: The unique id for the folder. readOnly: true title: Folder ID type: integer name: description: The name of the folder. title: Folder Name type: string title: Gallery 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 folder tags: - fileManager x-custom-config: methodNameCamel: getFolder methodNameSnake: get_folder patch: deprecated: false description: Update a specific File Manager folder. operationId: patchFileManagerFoldersId parameters: - description: The unique id for the File Manager folder. in: path name: folder_id required: true schema: type: string x-title: Folder ID requestBody: $ref: "#/components/requestBodies/postFileManagerFoldersBody" responses: "200": content: application/json: schema: description: An individual folder listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that created the folder. readOnly: true title: Created By type: string file_count: description: The number of files in the folder. readOnly: true title: File Count type: integer id: description: The unique id for the folder. readOnly: true title: Folder ID type: integer name: description: The name of the folder. title: Folder Name type: string title: Gallery Folder type: object application/problem+json: schema: description: An individual folder listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that created the folder. readOnly: true title: Created By type: string file_count: description: The number of files in the folder. readOnly: true title: File Count type: integer id: description: The unique id for the folder. readOnly: true title: Folder ID type: integer name: description: The name of the folder. title: Folder Name type: string title: Gallery 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 folder tags: - fileManager x-custom-config: methodNameCamel: updateFolder methodNameSnake: update_folder "/file-manager/folders/{folder_id}/files": get: deprecated: false description: Get a list of available images and files stored in this folder. operationId: getFileManagerFoldersFiles parameters: - description: The unique id for the File Manager folder. in: path name: folder_id required: true schema: type: string x-title: Folder ID - 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 file type for the File Manager file. in: query name: type required: false schema: type: string x-title: File Type - description: The Mailchimp account user who created the File Manager file. in: query name: created_by required: false schema: type: string x-title: Created By - description: "Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_created_at required: false schema: type: string x-title: Before Created At - description: "Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_created_at required: false schema: type: string x-title: Since Created At - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - added_date - name - size 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: A list of available images and files stored in the File Manager for 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 files: description: " A list of files and images in an account." items: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File type: object title: Files type: array total_file_size: description: The total size of all File Manager files in bytes. readOnly: true title: Total File Size type: number total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: File Manager type: object application/problem+json: schema: description: A list of available images and files stored in the File Manager for 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 files: description: " A list of files and images in an account." items: description: An individual file listed in the File Manager. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true title: Created Date type: string created_by: description: The username of the profile that uploaded the file. readOnly: true title: Created By type: string folder_id: description: The id of the folder. title: Folder ID type: integer full_size_url: description: The url of the full-size file. format: uri readOnly: true title: File URL type: string height: description: The height of an image. readOnly: true title: Image Height type: integer id: description: The unique id of the file. readOnly: true title: File ID type: integer name: description: The name of the file. title: File Name type: string size: description: The size of the file in bytes. readOnly: true title: File Size type: integer thumbnail_url: description: The url of the thumbnail preview. format: uri readOnly: true title: Thumbnail URL type: string type: description: The type of file in the File Manager. enum: - image - file readOnly: true title: File Type type: string width: description: The width of the image. readOnly: true title: Image Width type: integer title: Gallery File type: object title: Files type: array total_file_size: description: The total size of all File Manager files in bytes. readOnly: true title: Total File Size type: number total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: File Manager 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 stored files tags: - fileManager x-custom-config: methodNameCamel: foldersFiles methodNameSnake: folders_files /landing-pages: get: description: Get all landing pages. operationId: getAllLandingPages parameters: - 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 - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - created_at - updated_at type: string x-title: Sort By Field - 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 responses: "200": content: application/json: schema: description: A collection of landing pages. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array landing_pages: description: The landing pages on the account items: description: A summary of an individual landing page'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 created_at: description: The time this landing page was created. format: date-time readOnly: true title: Created At type: string created_by_source: description: Created by mobile or web readOnly: true title: Created By Source type: string description: description: The description of this landing page. readOnly: false title: Landing Page description type: string id: description: A string that uniquely identifies this landing page. example: 030092c2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false title: Landing Page list id type: string name: description: The name of this landing page. readOnly: false title: Landing Page Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published at type: string status: description: The status of this landing page. enum: - published - unpublished - draft readOnly: true title: Landing Page status type: string store_id: description: The ID of the store associated with this landing page. readOnly: false title: Store ID type: string template_id: description: The template_id of this landing page. readOnly: true title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. readOnly: false title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished at type: string updated_at: description: The time this landing page was updated at. format: date-time readOnly: true title: Updated_at type: string url: description: The url of the published landing page. readOnly: true title: Published url type: string web_id: description: The ID used in the Mailchimp web application. title: Landing Page Web ID type: integer title: Landing Page type: object 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: A collection of landing pages. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array landing_pages: description: The landing pages on the account items: description: A summary of an individual landing page'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 created_at: description: The time this landing page was created. format: date-time readOnly: true title: Created At type: string created_by_source: description: Created by mobile or web readOnly: true title: Created By Source type: string description: description: The description of this landing page. readOnly: false title: Landing Page description type: string id: description: A string that uniquely identifies this landing page. example: 030092c2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false title: Landing Page list id type: string name: description: The name of this landing page. readOnly: false title: Landing Page Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published at type: string status: description: The status of this landing page. enum: - published - unpublished - draft readOnly: true title: Landing Page status type: string store_id: description: The ID of the store associated with this landing page. readOnly: false title: Store ID type: string template_id: description: The template_id of this landing page. readOnly: true title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. readOnly: false title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished at type: string updated_at: description: The time this landing page was updated at. format: date-time readOnly: true title: Updated_at type: string url: description: The url of the published landing page. readOnly: true title: Published url type: string web_id: description: The ID used in the Mailchimp web application. title: Landing Page Web ID type: integer title: Landing Page type: object 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: Landing Pages 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: List landing pages tags: - landingPages x-custom-config: methodNameCamel: getAll methodNameSnake: get_all post: deprecated: false description: Create a new Mailchimp landing page. operationId: postAllLandingPages parameters: - description: Will create the Landing Page using the account's Default List instead of requiring a list_id. in: query name: use_default_list required: false schema: type: boolean x-title: Use Default List requestBody: content: application/json: schema: description: A summary of an individual page's properties. properties: description: description: The description of this landing page. title: Landing Page description type: string list_id: description: The list's ID associated with this landing page. title: Landing Page list id type: string name: description: The name of this landing page. title: Landing Page Name type: string store_id: description: The ID of the store associated with this landing page. title: Store ID type: string template_id: description: The template_id of this landing page. example: 1001 title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object type: description: The type of template the landing page has. enum: - signup - product example: signup title: Landing Page Template Type type: string title: Landing Page type: object required: true responses: "200": content: application/json: schema: description: A summary of an individual landing page'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 created_at: description: The time this landing page was created. format: date-time readOnly: true title: Created At type: string created_by_source: description: Created by mobile or web readOnly: true title: Created By Source type: string description: description: The description of this landing page. readOnly: false title: Landing Page description type: string id: description: A string that uniquely identifies this landing page. example: 030092c2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false title: Landing Page list id type: string name: description: The name of this landing page. readOnly: false title: Landing Page Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published at type: string status: description: The status of this landing page. enum: - published - unpublished - draft readOnly: true title: Landing Page status type: string store_id: description: The ID of the store associated with this landing page. readOnly: false title: Store ID type: string template_id: description: The template_id of this landing page. readOnly: true title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. readOnly: false title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished at type: string updated_at: description: The time this landing page was updated at. format: date-time readOnly: true title: Updated_at type: string url: description: The url of the published landing page. readOnly: true title: Published url type: string web_id: description: The ID used in the Mailchimp web application. title: Landing Page Web ID type: integer title: Landing Page type: object application/problem+json: schema: description: A summary of an individual landing page'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 created_at: description: The time this landing page was created. format: date-time readOnly: true title: Created At type: string created_by_source: description: Created by mobile or web readOnly: true title: Created By Source type: string description: description: The description of this landing page. readOnly: false title: Landing Page description type: string id: description: A string that uniquely identifies this landing page. example: 030092c2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false title: Landing Page list id type: string name: description: The name of this landing page. readOnly: false title: Landing Page Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published at type: string status: description: The status of this landing page. enum: - published - unpublished - draft readOnly: true title: Landing Page status type: string store_id: description: The ID of the store associated with this landing page. readOnly: false title: Store ID type: string template_id: description: The template_id of this landing page. readOnly: true title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. readOnly: false title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished at type: string updated_at: description: The time this landing page was updated at. format: date-time readOnly: true title: Updated_at type: string url: description: The url of the published landing page. readOnly: true title: Published url type: string web_id: description: The ID used in the Mailchimp web application. title: Landing Page Web ID type: integer title: Landing Page 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 landing page tags: - landingPages x-custom-config: methodNameCamel: create methodNameSnake: create "/landing-pages/{page_id}": delete: deprecated: false description: Delete a landing page. operationId: deleteLandingPageId parameters: - description: The unique id for the page. in: path name: page_id required: true schema: type: string x-title: Landing Page unique 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 landing page tags: - landingPages x-custom-config: methodNameCamel: deletePage methodNameSnake: delete_page get: deprecated: false description: Get information about a specific page. operationId: getLandingPageId 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 page. in: path name: page_id required: true schema: type: string x-title: Landing Page unique ID responses: "200": content: application/json: schema: description: A summary of an individual landing page'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 created_at: description: The time this landing page was created. format: date-time readOnly: true title: Created At type: string created_by_source: description: Created by mobile or web readOnly: true title: Created By Source type: string description: description: The description of this landing page. readOnly: false title: Landing Page description type: string id: description: A string that uniquely identifies this landing page. example: 030092c2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false title: Landing Page list id type: string name: description: The name of this landing page. readOnly: false title: Landing Page Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published at type: string status: description: The status of this landing page. enum: - published - unpublished - draft readOnly: true title: Landing Page status type: string store_id: description: The ID of the store associated with this landing page. readOnly: false title: Store ID type: string template_id: description: The template_id of this landing page. readOnly: true title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. readOnly: false title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished at type: string updated_at: description: The time this landing page was updated at. format: date-time readOnly: true title: Updated_at type: string url: description: The url of the published landing page. readOnly: true title: Published url type: string web_id: description: The ID used in the Mailchimp web application. title: Landing Page Web ID type: integer title: Landing Page type: object application/problem+json: schema: description: A summary of an individual landing page'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 created_at: description: The time this landing page was created. format: date-time readOnly: true title: Created At type: string created_by_source: description: Created by mobile or web readOnly: true title: Created By Source type: string description: description: The description of this landing page. readOnly: false title: Landing Page description type: string id: description: A string that uniquely identifies this landing page. example: 030092c2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false title: Landing Page list id type: string name: description: The name of this landing page. readOnly: false title: Landing Page Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published at type: string status: description: The status of this landing page. enum: - published - unpublished - draft readOnly: true title: Landing Page status type: string store_id: description: The ID of the store associated with this landing page. readOnly: false title: Store ID type: string template_id: description: The template_id of this landing page. readOnly: true title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. readOnly: false title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished at type: string updated_at: description: The time this landing page was updated at. format: date-time readOnly: true title: Updated_at type: string url: description: The url of the published landing page. readOnly: true title: Published url type: string web_id: description: The ID used in the Mailchimp web application. title: Landing Page Web ID type: integer title: Landing Page type: object description: Landing Pages Instance 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 landing page info tags: - landingPages x-custom-config: methodNameCamel: getPage methodNameSnake: get_page patch: description: Update a landing page. operationId: patchLandingPageId parameters: - description: The unique id for the page. in: path name: page_id required: true schema: type: string x-title: Landing Page unique ID requestBody: content: application/json: schema: description: A summary of an individual page's properties. properties: description: description: The description of this landing page. title: Landing Page description type: string list_id: description: The list's ID associated with this landing page. title: Landing Page list id type: string name: description: The name of this landing page. title: Landing Page Name type: string store_id: description: The ID of the store associated with this landing page. title: Store ID type: string title: description: The title of this landing page seen in the browser's title bar. title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object title: Landing Page type: object required: true responses: "200": content: application/json: schema: description: A summary of an individual landing page'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 created_at: description: The time this landing page was created. format: date-time readOnly: true title: Created At type: string created_by_source: description: Created by mobile or web readOnly: true title: Created By Source type: string description: description: The description of this landing page. readOnly: false title: Landing Page description type: string id: description: A string that uniquely identifies this landing page. example: 030092c2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false title: Landing Page list id type: string name: description: The name of this landing page. readOnly: false title: Landing Page Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published at type: string status: description: The status of this landing page. enum: - published - unpublished - draft readOnly: true title: Landing Page status type: string store_id: description: The ID of the store associated with this landing page. readOnly: false title: Store ID type: string template_id: description: The template_id of this landing page. readOnly: true title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. readOnly: false title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished at type: string updated_at: description: The time this landing page was updated at. format: date-time readOnly: true title: Updated_at type: string url: description: The url of the published landing page. readOnly: true title: Published url type: string web_id: description: The ID used in the Mailchimp web application. title: Landing Page Web ID type: integer title: Landing Page type: object application/problem+json: schema: description: A summary of an individual landing page'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 created_at: description: The time this landing page was created. format: date-time readOnly: true title: Created At type: string created_by_source: description: Created by mobile or web readOnly: true title: Created By Source type: string description: description: The description of this landing page. readOnly: false title: Landing Page description type: string id: description: A string that uniquely identifies this landing page. example: 030092c2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false title: Landing Page list id type: string name: description: The name of this landing page. readOnly: false title: Landing Page Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published at type: string status: description: The status of this landing page. enum: - published - unpublished - draft readOnly: true title: Landing Page status type: string store_id: description: The ID of the store associated with this landing page. readOnly: false title: Store ID type: string template_id: description: The template_id of this landing page. readOnly: true title: Landing Page template_id type: integer title: description: The title of this landing page seen in the browser's title bar. readOnly: false title: Landing Page title type: string tracking: description: The tracking settings applied to this landing page. properties: enable_restricted_data_processing: description: Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). title: Enable restricted data processing type: boolean track_with_mailchimp: description: Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). title: Track with Mailchimp type: boolean title: Tracking Settings type: object unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished at type: string updated_at: description: The time this landing page was updated at. format: date-time readOnly: true title: Updated_at type: string url: description: The url of the published landing page. readOnly: true title: Published url type: string web_id: description: The ID used in the Mailchimp web application. title: Landing Page Web ID type: integer title: Landing Page 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 landing page tags: - landingPages x-custom-config: methodNameCamel: updatePage methodNameSnake: update_page "/landing-pages/{page_id}/actions/publish": post: deprecated: false description: Publish a landing page that is in draft, unpublished, or has been previously published and edited. operationId: postLandingPageIdActionsPublish parameters: - description: The unique id for the page. in: path name: page_id required: true schema: type: string x-title: Landing Page unique 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: Publish landing page tags: - landingPages x-custom-config: methodNameCamel: publishPage methodNameSnake: publish_page "/landing-pages/{page_id}/actions/unpublish": post: deprecated: false description: Unpublish a landing page that is in draft or has been published. operationId: postLandingPageIdActionsUnpublish parameters: - description: The unique id for the page. in: path name: page_id required: true schema: type: string x-title: Landing Page unique 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: Unpublish landing page tags: - landingPages x-custom-config: methodNameCamel: unpublishPage methodNameSnake: unpublish_page "/landing-pages/{page_id}/content": get: deprecated: false description: Get the the HTML for your landing page. operationId: getLandingPageIdContent 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 page. in: path name: page_id required: true schema: type: string x-title: Landing Page unique ID responses: "200": content: application/json: schema: description: The HTML content for a landing page. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array html: description: The raw HTML for the landing page. title: Landing Page HTML type: string json: description: The JSON Structure for the landing page title: Landing Page JSON type: string title: Landing Page Content type: object application/problem+json: schema: description: The HTML content for a landing page. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array html: description: The raw HTML for the landing page. title: Landing Page HTML type: string json: description: The JSON Structure for the landing page title: Landing Page JSON type: string title: Landing Page 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 landing page content tags: - landingPages x-custom-config: methodNameCamel: getPageContent methodNameSnake: get_page_content /lists: get: deprecated: false description: Get information about all lists in the account. operationId: getLists 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 response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_date_created required: false schema: type: string x-title: Before Date Created - description: "Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_date_created required: false schema: type: string x-title: Since Date Created - description: "Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_campaign_last_sent required: false schema: type: string x-title: Before Campaign Last Sent - description: "Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_campaign_last_sent required: false schema: type: string x-title: Since Campaign Last Sent - description: Restrict results to lists that include a specific subscriber's email address. in: query name: email required: false schema: type: string x-title: Subscriber Email - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - date_created 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 - description: Restrict results to lists that contain an active, connected, undeleted ecommerce store. in: query name: has_ecommerce_store required: false schema: type: boolean x-title: Has Ecommerce Store - description: Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. in: query name: include_total_contacts required: false schema: type: boolean x-title: Include Total Contacts responses: "200": content: application/json: schema: description: A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array constraints: description: Do particular authorization constraints around this collection limit creation of new instances? properties: current_total_instances: description: How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited. title: Current total instances type: integer max_instances: description: How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited. title: Max instances type: integer may_create: description: May the user create additional instances of this resource? title: Resource creation authorization type: boolean required: - may_create - max_instances title: Collection Authorization type: object lists: description: An array of objects, each representing a list. items: description: Information about a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array beamer_address: description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true title: Beamer Address type: string campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string title: List Contact type: object date_created: description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true title: Creation Date type: string double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean has_welcome: default: false description: "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup." example: false title: Has Welcome type: boolean id: description: A string that uniquely identifies this list. readOnly: true title: List ID type: string list_rating: description: An auto-generated activity score for the list (0-5). readOnly: true title: List Rating type: integer marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean modules: description: Any list-specific modules installed for this list. items: type: string readOnly: true title: Modules type: array name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string stats: description: Stats for the list. Many of these are cached for at least five minutes. properties: avg_sub_rate: description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number avg_unsub_rate: description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Unsubscription Rate type: number campaign_count: description: The number of campaigns in any status that use this list. readOnly: true title: Campaign Count type: integer campaign_last_sent: description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. format: date-time readOnly: true title: Campaign Last Sent type: string cleaned_count: description: The number of members cleaned from the list. readOnly: true title: Cleaned Count type: integer cleaned_count_since_send: description: The number of members cleaned from the list since the last campaign was sent. readOnly: true title: Cleaned Count Since Send type: integer click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Click Rate type: number last_sub_date: description: The date and time of the last time someone subscribed to this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Subscribe type: string last_unsub_date: description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Unsubscribe type: string member_count: description: The number of active members in the list. readOnly: true title: Member Count type: integer member_count_since_send: description: The number of active members in the list since the last campaign was sent. readOnly: true title: Member Count Since Send type: integer merge_field_count: description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true title: Merge Field Count type: integer open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Open Rate type: number target_sub_rate: description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number total_contacts: description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true title: Total Contacts type: integer unsubscribe_count: description: The number of members who have unsubscribed from the list. readOnly: true title: Unsubscribe Count type: integer unsubscribe_count_since_send: description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true title: Unsubscribe Count Since Send type: integer readOnly: true title: Statistics type: object subscribe_url_long: description: The full version of this list's subscribe form (host will vary). readOnly: true title: Subscribe URL Long type: string subscribe_url_short: description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true title: Subscribe URL Short type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean visibility: description: Legacy - visibility settings are no longer used enum: - pub - prv title: Visibility type: string web_id: description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true title: List Web ID type: integer title: Subscriber List type: object title: Lists type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer required: - lists title: Subscriber Lists type: object application/problem+json: schema: description: A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array constraints: description: Do particular authorization constraints around this collection limit creation of new instances? properties: current_total_instances: description: How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited. title: Current total instances type: integer max_instances: description: How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited. title: Max instances type: integer may_create: description: May the user create additional instances of this resource? title: Resource creation authorization type: boolean required: - may_create - max_instances title: Collection Authorization type: object lists: description: An array of objects, each representing a list. items: description: Information about a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array beamer_address: description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true title: Beamer Address type: string campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string title: List Contact type: object date_created: description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true title: Creation Date type: string double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean has_welcome: default: false description: "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup." example: false title: Has Welcome type: boolean id: description: A string that uniquely identifies this list. readOnly: true title: List ID type: string list_rating: description: An auto-generated activity score for the list (0-5). readOnly: true title: List Rating type: integer marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean modules: description: Any list-specific modules installed for this list. items: type: string readOnly: true title: Modules type: array name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string stats: description: Stats for the list. Many of these are cached for at least five minutes. properties: avg_sub_rate: description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number avg_unsub_rate: description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Unsubscription Rate type: number campaign_count: description: The number of campaigns in any status that use this list. readOnly: true title: Campaign Count type: integer campaign_last_sent: description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. format: date-time readOnly: true title: Campaign Last Sent type: string cleaned_count: description: The number of members cleaned from the list. readOnly: true title: Cleaned Count type: integer cleaned_count_since_send: description: The number of members cleaned from the list since the last campaign was sent. readOnly: true title: Cleaned Count Since Send type: integer click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Click Rate type: number last_sub_date: description: The date and time of the last time someone subscribed to this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Subscribe type: string last_unsub_date: description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Unsubscribe type: string member_count: description: The number of active members in the list. readOnly: true title: Member Count type: integer member_count_since_send: description: The number of active members in the list since the last campaign was sent. readOnly: true title: Member Count Since Send type: integer merge_field_count: description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true title: Merge Field Count type: integer open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Open Rate type: number target_sub_rate: description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number total_contacts: description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true title: Total Contacts type: integer unsubscribe_count: description: The number of members who have unsubscribed from the list. readOnly: true title: Unsubscribe Count type: integer unsubscribe_count_since_send: description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true title: Unsubscribe Count Since Send type: integer readOnly: true title: Statistics type: object subscribe_url_long: description: The full version of this list's subscribe form (host will vary). readOnly: true title: Subscribe URL Long type: string subscribe_url_short: description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true title: Subscribe URL Short type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean visibility: description: Legacy - visibility settings are no longer used enum: - pub - prv title: Visibility type: string web_id: description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true title: List Web ID type: integer title: Subscriber List type: object title: Lists type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer required: - lists title: Subscriber Lists 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 lists info tags: - lists x-custom-config: methodNameCamel: getAllLists methodNameSnake: get_all_lists post: deprecated: false description: Create a new list in your Mailchimp account. operationId: postLists requestBody: content: application/json: schema: description: Information about a specific list. properties: campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string required: - from_name - from_email - subject - language title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string required: - company - address1 - city - country title: List Contact type: object double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean required: - name - permission_reminder - email_type_option - contact - campaign_defaults title: Subscriber List type: object required: true responses: "200": content: application/json: schema: description: Information about a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array beamer_address: description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true title: Beamer Address type: string campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string title: List Contact type: object date_created: description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true title: Creation Date type: string double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean has_welcome: default: false description: "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup." example: false title: Has Welcome type: boolean id: description: A string that uniquely identifies this list. readOnly: true title: List ID type: string list_rating: description: An auto-generated activity score for the list (0-5). readOnly: true title: List Rating type: integer marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean modules: description: Any list-specific modules installed for this list. items: type: string readOnly: true title: Modules type: array name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string stats: description: Stats for the list. Many of these are cached for at least five minutes. properties: avg_sub_rate: description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number avg_unsub_rate: description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Unsubscription Rate type: number campaign_count: description: The number of campaigns in any status that use this list. readOnly: true title: Campaign Count type: integer campaign_last_sent: description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. format: date-time readOnly: true title: Campaign Last Sent type: string cleaned_count: description: The number of members cleaned from the list. readOnly: true title: Cleaned Count type: integer cleaned_count_since_send: description: The number of members cleaned from the list since the last campaign was sent. readOnly: true title: Cleaned Count Since Send type: integer click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Click Rate type: number last_sub_date: description: The date and time of the last time someone subscribed to this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Subscribe type: string last_unsub_date: description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Unsubscribe type: string member_count: description: The number of active members in the list. readOnly: true title: Member Count type: integer member_count_since_send: description: The number of active members in the list since the last campaign was sent. readOnly: true title: Member Count Since Send type: integer merge_field_count: description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true title: Merge Field Count type: integer open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Open Rate type: number target_sub_rate: description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number total_contacts: description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true title: Total Contacts type: integer unsubscribe_count: description: The number of members who have unsubscribed from the list. readOnly: true title: Unsubscribe Count type: integer unsubscribe_count_since_send: description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true title: Unsubscribe Count Since Send type: integer readOnly: true title: Statistics type: object subscribe_url_long: description: The full version of this list's subscribe form (host will vary). readOnly: true title: Subscribe URL Long type: string subscribe_url_short: description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true title: Subscribe URL Short type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean visibility: description: Legacy - visibility settings are no longer used enum: - pub - prv title: Visibility type: string web_id: description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true title: List Web ID type: integer title: Subscriber List type: object application/problem+json: schema: description: Information about a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array beamer_address: description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true title: Beamer Address type: string campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string title: List Contact type: object date_created: description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true title: Creation Date type: string double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean has_welcome: default: false description: "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup." example: false title: Has Welcome type: boolean id: description: A string that uniquely identifies this list. readOnly: true title: List ID type: string list_rating: description: An auto-generated activity score for the list (0-5). readOnly: true title: List Rating type: integer marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean modules: description: Any list-specific modules installed for this list. items: type: string readOnly: true title: Modules type: array name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string stats: description: Stats for the list. Many of these are cached for at least five minutes. properties: avg_sub_rate: description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number avg_unsub_rate: description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Unsubscription Rate type: number campaign_count: description: The number of campaigns in any status that use this list. readOnly: true title: Campaign Count type: integer campaign_last_sent: description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. format: date-time readOnly: true title: Campaign Last Sent type: string cleaned_count: description: The number of members cleaned from the list. readOnly: true title: Cleaned Count type: integer cleaned_count_since_send: description: The number of members cleaned from the list since the last campaign was sent. readOnly: true title: Cleaned Count Since Send type: integer click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Click Rate type: number last_sub_date: description: The date and time of the last time someone subscribed to this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Subscribe type: string last_unsub_date: description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Unsubscribe type: string member_count: description: The number of active members in the list. readOnly: true title: Member Count type: integer member_count_since_send: description: The number of active members in the list since the last campaign was sent. readOnly: true title: Member Count Since Send type: integer merge_field_count: description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true title: Merge Field Count type: integer open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Open Rate type: number target_sub_rate: description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number total_contacts: description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true title: Total Contacts type: integer unsubscribe_count: description: The number of members who have unsubscribed from the list. readOnly: true title: Unsubscribe Count type: integer unsubscribe_count_since_send: description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true title: Unsubscribe Count Since Send type: integer readOnly: true title: Statistics type: object subscribe_url_long: description: The full version of this list's subscribe form (host will vary). readOnly: true title: Subscribe URL Long type: string subscribe_url_short: description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true title: Subscribe URL Short type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean visibility: description: Legacy - visibility settings are no longer used enum: - pub - prv title: Visibility type: string web_id: description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true title: List Web ID type: integer title: Subscriber List 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 list tags: - lists x-custom-config: methodNameCamel: createList methodNameSnake: create_list "/lists/{list_id}": delete: deprecated: false description: Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list. operationId: deleteListsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List 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 list tags: - lists x-custom-config: methodNameCamel: deleteList methodNameSnake: delete_list get: deprecated: false description: Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned. operationId: getListsId 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 list. in: path name: list_id required: true schema: type: string x-title: List ID - description: Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. in: query name: include_total_contacts required: false schema: type: boolean x-title: Include Total Contacts responses: "200": content: application/json: schema: description: Information about a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array beamer_address: description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true title: Beamer Address type: string campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string title: List Contact type: object date_created: description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true title: Creation Date type: string double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean has_welcome: default: false description: "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup." example: false title: Has Welcome type: boolean id: description: A string that uniquely identifies this list. readOnly: true title: List ID type: string list_rating: description: An auto-generated activity score for the list (0-5). readOnly: true title: List Rating type: integer marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean modules: description: Any list-specific modules installed for this list. items: type: string readOnly: true title: Modules type: array name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string stats: description: Stats for the list. Many of these are cached for at least five minutes. properties: avg_sub_rate: description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number avg_unsub_rate: description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Unsubscription Rate type: number campaign_count: description: The number of campaigns in any status that use this list. readOnly: true title: Campaign Count type: integer campaign_last_sent: description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. format: date-time readOnly: true title: Campaign Last Sent type: string cleaned_count: description: The number of members cleaned from the list. readOnly: true title: Cleaned Count type: integer cleaned_count_since_send: description: The number of members cleaned from the list since the last campaign was sent. readOnly: true title: Cleaned Count Since Send type: integer click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Click Rate type: number last_sub_date: description: The date and time of the last time someone subscribed to this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Subscribe type: string last_unsub_date: description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Unsubscribe type: string member_count: description: The number of active members in the list. readOnly: true title: Member Count type: integer member_count_since_send: description: The number of active members in the list since the last campaign was sent. readOnly: true title: Member Count Since Send type: integer merge_field_count: description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true title: Merge Field Count type: integer open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Open Rate type: number target_sub_rate: description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number total_contacts: description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true title: Total Contacts type: integer unsubscribe_count: description: The number of members who have unsubscribed from the list. readOnly: true title: Unsubscribe Count type: integer unsubscribe_count_since_send: description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true title: Unsubscribe Count Since Send type: integer readOnly: true title: Statistics type: object subscribe_url_long: description: The full version of this list's subscribe form (host will vary). readOnly: true title: Subscribe URL Long type: string subscribe_url_short: description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true title: Subscribe URL Short type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean visibility: description: Legacy - visibility settings are no longer used enum: - pub - prv title: Visibility type: string web_id: description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true title: List Web ID type: integer title: Subscriber List type: object application/problem+json: schema: description: Information about a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array beamer_address: description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true title: Beamer Address type: string campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string title: List Contact type: object date_created: description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true title: Creation Date type: string double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean has_welcome: default: false description: "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup." example: false title: Has Welcome type: boolean id: description: A string that uniquely identifies this list. readOnly: true title: List ID type: string list_rating: description: An auto-generated activity score for the list (0-5). readOnly: true title: List Rating type: integer marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean modules: description: Any list-specific modules installed for this list. items: type: string readOnly: true title: Modules type: array name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string stats: description: Stats for the list. Many of these are cached for at least five minutes. properties: avg_sub_rate: description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number avg_unsub_rate: description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Unsubscription Rate type: number campaign_count: description: The number of campaigns in any status that use this list. readOnly: true title: Campaign Count type: integer campaign_last_sent: description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. format: date-time readOnly: true title: Campaign Last Sent type: string cleaned_count: description: The number of members cleaned from the list. readOnly: true title: Cleaned Count type: integer cleaned_count_since_send: description: The number of members cleaned from the list since the last campaign was sent. readOnly: true title: Cleaned Count Since Send type: integer click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Click Rate type: number last_sub_date: description: The date and time of the last time someone subscribed to this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Subscribe type: string last_unsub_date: description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Unsubscribe type: string member_count: description: The number of active members in the list. readOnly: true title: Member Count type: integer member_count_since_send: description: The number of active members in the list since the last campaign was sent. readOnly: true title: Member Count Since Send type: integer merge_field_count: description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true title: Merge Field Count type: integer open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Open Rate type: number target_sub_rate: description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number total_contacts: description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true title: Total Contacts type: integer unsubscribe_count: description: The number of members who have unsubscribed from the list. readOnly: true title: Unsubscribe Count type: integer unsubscribe_count_since_send: description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true title: Unsubscribe Count Since Send type: integer readOnly: true title: Statistics type: object subscribe_url_long: description: The full version of this list's subscribe form (host will vary). readOnly: true title: Subscribe URL Long type: string subscribe_url_short: description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true title: Subscribe URL Short type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean visibility: description: Legacy - visibility settings are no longer used enum: - pub - prv title: Visibility type: string web_id: description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true title: List Web ID type: integer title: Subscriber List 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 list info tags: - lists x-custom-config: methodNameCamel: getList methodNameSnake: get_list patch: deprecated: false description: Update the settings for a specific list. operationId: patchListsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID requestBody: content: application/json: schema: description: Information about a specific list. properties: campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string required: - from_name - from_email - subject - language title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string required: - company - address1 - city - state - zip - country title: List Contact type: object double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean required: - name - permission_reminder - email_type_option - contact - campaign_defaults title: Subscriber List type: object required: true responses: "200": content: application/json: schema: description: Information about a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array beamer_address: description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true title: Beamer Address type: string campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string title: List Contact type: object date_created: description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true title: Creation Date type: string double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean has_welcome: default: false description: "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup." example: false title: Has Welcome type: boolean id: description: A string that uniquely identifies this list. readOnly: true title: List ID type: string list_rating: description: An auto-generated activity score for the list (0-5). readOnly: true title: List Rating type: integer marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean modules: description: Any list-specific modules installed for this list. items: type: string readOnly: true title: Modules type: array name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string stats: description: Stats for the list. Many of these are cached for at least five minutes. properties: avg_sub_rate: description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number avg_unsub_rate: description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Unsubscription Rate type: number campaign_count: description: The number of campaigns in any status that use this list. readOnly: true title: Campaign Count type: integer campaign_last_sent: description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. format: date-time readOnly: true title: Campaign Last Sent type: string cleaned_count: description: The number of members cleaned from the list. readOnly: true title: Cleaned Count type: integer cleaned_count_since_send: description: The number of members cleaned from the list since the last campaign was sent. readOnly: true title: Cleaned Count Since Send type: integer click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Click Rate type: number last_sub_date: description: The date and time of the last time someone subscribed to this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Subscribe type: string last_unsub_date: description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Unsubscribe type: string member_count: description: The number of active members in the list. readOnly: true title: Member Count type: integer member_count_since_send: description: The number of active members in the list since the last campaign was sent. readOnly: true title: Member Count Since Send type: integer merge_field_count: description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true title: Merge Field Count type: integer open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Open Rate type: number target_sub_rate: description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number total_contacts: description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true title: Total Contacts type: integer unsubscribe_count: description: The number of members who have unsubscribed from the list. readOnly: true title: Unsubscribe Count type: integer unsubscribe_count_since_send: description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true title: Unsubscribe Count Since Send type: integer readOnly: true title: Statistics type: object subscribe_url_long: description: The full version of this list's subscribe form (host will vary). readOnly: true title: Subscribe URL Long type: string subscribe_url_short: description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true title: Subscribe URL Short type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean visibility: description: Legacy - visibility settings are no longer used enum: - pub - prv title: Visibility type: string web_id: description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true title: List Web ID type: integer title: Subscriber List type: object application/problem+json: schema: description: Information about a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array beamer_address: description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true title: Beamer Address type: string campaign_defaults: description: "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list." properties: from_email: description: The default from email for campaigns sent to this list. title: Sender's Email Address type: string from_name: description: The default from name for campaigns sent to this list. title: Sender's Name type: string language: description: The default language for this lists's forms. title: Language type: string subject: description: The default subject line for campaigns sent to this list. title: Subject type: string title: Campaign Defaults type: object contact: description: "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws." properties: address1: description: The street address for the list contact. title: Address type: string address2: description: The street address for the list contact. title: Address type: string city: description: The city for the list contact. title: City type: string company: description: The company name for the list. title: Company Name type: string country: description: A two-character ISO3166 country code. Defaults to US if invalid. title: Country Code type: string phone: description: The phone number for the list contact. title: Phone Number type: string state: description: The state for the list contact. title: State type: string zip: description: The postal or zip code for the list contact. title: Postal Code type: string title: List Contact type: object date_created: description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true title: Creation Date type: string double_optin: default: false description: Whether or not to require the subscriber to confirm subscription via email. title: Double Opt In type: boolean email_type_option: description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. title: Email Type Option type: boolean has_welcome: default: false description: "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup." example: false title: Has Welcome type: boolean id: description: A string that uniquely identifies this list. readOnly: true title: List ID type: string list_rating: description: An auto-generated activity score for the list (0-5). readOnly: true title: List Rating type: integer marketing_permissions: default: false description: Whether or not the list has marketing permissions (eg. GDPR) enabled. title: Marketing Permissions type: boolean modules: description: Any list-specific modules installed for this list. items: type: string readOnly: true title: Modules type: array name: description: The name of the list. title: List Name type: string notify_on_subscribe: default: false description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Subscribe type: string notify_on_unsubscribe: default: false description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. title: Notify on Unsubscribe type: string permission_reminder: description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. title: Permission Reminder type: string stats: description: Stats for the list. Many of these are cached for at least five minutes. properties: avg_sub_rate: description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number avg_unsub_rate: description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true title: Average Unsubscription Rate type: number campaign_count: description: The number of campaigns in any status that use this list. readOnly: true title: Campaign Count type: integer campaign_last_sent: description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. format: date-time readOnly: true title: Campaign Last Sent type: string cleaned_count: description: The number of members cleaned from the list. readOnly: true title: Cleaned Count type: integer cleaned_count_since_send: description: The number of members cleaned from the list since the last campaign was sent. readOnly: true title: Cleaned Count Since Send type: integer click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Click Rate type: number last_sub_date: description: The date and time of the last time someone subscribed to this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Subscribe type: string last_unsub_date: description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. format: date-time readOnly: true title: Date of Last List Unsubscribe type: string member_count: description: The number of active members in the list. readOnly: true title: Member Count type: integer member_count_since_send: description: The number of active members in the list since the last campaign was sent. readOnly: true title: Member Count Since Send type: integer merge_field_count: description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true title: Merge Field Count type: integer open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true title: Open Rate type: number target_sub_rate: description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true title: Average Subscription Rate type: number total_contacts: description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true title: Total Contacts type: integer unsubscribe_count: description: The number of members who have unsubscribed from the list. readOnly: true title: Unsubscribe Count type: integer unsubscribe_count_since_send: description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true title: Unsubscribe Count Since Send type: integer readOnly: true title: Statistics type: object subscribe_url_long: description: The full version of this list's subscribe form (host will vary). readOnly: true title: Subscribe URL Long type: string subscribe_url_short: description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true title: Subscribe URL Short type: string use_archive_bar: default: false description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. title: Use Archive Bar type: boolean visibility: description: Legacy - visibility settings are no longer used enum: - pub - prv title: Visibility type: string web_id: description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true title: List Web ID type: integer title: Subscriber List 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 lists tags: - lists x-custom-config: methodNameCamel: updateList methodNameSnake: update_list post: deprecated: false description: Batch subscribe or unsubscribe list members. operationId: postListsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. in: query name: skip_merge_validation required: false schema: type: boolean x-title: Skip Merge Validation - description: If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false. in: query name: skip_duplicate_check required: false schema: type: boolean x-title: Skip Duplicate Check requestBody: content: application/json: schema: description: Members to subscribe to or unsubscribe from a list. properties: members: description: An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: description: Email address for a subscriber. title: Email Address type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string location: description: Subscriber location information. properties: latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number title: Location type: object merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time title: Signup Timestamp type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: Add List Members type: object title: List Members type: array sync_tags: description: Whether this batch operation will replace all existing tags with tags in request. title: Sync Tags type: boolean update_existing: description: Whether this batch operation will change existing members' subscription status. title: Update Existing Members type: boolean required: - members title: Members to Subscribe/Unsubscribe to/from a List in batch type: object required: true responses: "200": content: application/json: schema: description: Batch update list members. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array error_count: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer errors: description: An array of objects, each representing an email address that could not be added to the list or updated and an error message providing more details. items: properties: email_address: description: The email address that could not be added or updated. title: Member Email address type: string error: description: The error message indicating why the email address could not be added or updated. title: Error message type: string error_code: description: A unique code that identifies this specifc error. enum: - ERROR_CONTACT_EXISTS - ERROR_GENERIC title: Error code type: string field: description: If the error is field-related, information about which field is at issue. title: Field type: string field_message: description: Message indicating how to resolve a field-related error. title: Field message type: string type: object title: Errors type: array new_members: description: An array of objects, each representing a new member that was added to the list. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: An individual merge var and value for a member. title: Member Merge Var type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags applied to this member. items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: New members type: array total_created: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer total_updated: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer updated_members: description: An array of objects, each representing an existing list member whose subscription status was updated. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: An individual merge var and value for a member. title: Member Merge Var type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags applied to this member. items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: Updated Members type: array title: Batch update List members type: object application/problem+json: schema: description: Batch update list members. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array error_count: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer errors: description: An array of objects, each representing an email address that could not be added to the list or updated and an error message providing more details. items: properties: email_address: description: The email address that could not be added or updated. title: Member Email address type: string error: description: The error message indicating why the email address could not be added or updated. title: Error message type: string error_code: description: A unique code that identifies this specifc error. enum: - ERROR_CONTACT_EXISTS - ERROR_GENERIC title: Error code type: string field: description: If the error is field-related, information about which field is at issue. title: Field type: string field_message: description: Message indicating how to resolve a field-related error. title: Field message type: string type: object title: Errors type: array new_members: description: An array of objects, each representing a new member that was added to the list. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: An individual merge var and value for a member. title: Member Merge Var type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags applied to this member. items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: New members type: array total_created: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer total_updated: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer updated_members: description: An array of objects, each representing an existing list member whose subscription status was updated. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: An individual merge var and value for a member. title: Member Merge Var type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags applied to this member. items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: Updated Members type: array title: Batch update List members 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: Batch subscribe or unsubscribe tags: - lists x-custom-config: methodNameCamel: batchListMembers methodNameSnake: batch_list_members "/lists/{list_id}/abuse-reports": get: deprecated: false description: Get all abuse reports for a specific list. operationId: getListsIdAbuseReports 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 unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID responses: "200": content: application/json: schema: description: A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array abuse_reports: description: An array of objects, each representing an abuse report resource. items: description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id for the abuse report readOnly: true title: Campaign ID type: string date: description: Date for the abuse report readOnly: true title: Date type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The id for the abuse report readOnly: true title: Abuse Report ID type: integer list_id: description: The list id for the abuse report. readOnly: true title: List ID type: string merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Abuse Complaint type: object title: Abuse Reports type: array list_id: description: The list id for the abuse report. title: List 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: Abuse Complaints type: object application/problem+json: schema: description: A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array abuse_reports: description: An array of objects, each representing an abuse report resource. items: description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id for the abuse report readOnly: true title: Campaign ID type: string date: description: Date for the abuse report readOnly: true title: Date type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The id for the abuse report readOnly: true title: Abuse Report ID type: integer list_id: description: The list id for the abuse report. readOnly: true title: List ID type: string merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Abuse Complaint type: object title: Abuse Reports type: array list_id: description: The list id for the abuse report. title: List 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: Abuse Complaints 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 abuse reports tags: - lists x-custom-config: methodNameCamel: getListAbuseReports methodNameSnake: get_list_abuse_reports "/lists/{list_id}/abuse-reports/{report_id}": get: deprecated: false description: Get details about a specific abuse report. operationId: getListsIdAbuseReportsId 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 unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The id for the abuse report. in: path name: report_id required: true schema: type: string responses: "200": content: application/json: schema: description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id for the abuse report readOnly: true title: Campaign ID type: string date: description: Date for the abuse report readOnly: true title: Date type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The id for the abuse report readOnly: true title: Abuse Report ID type: integer list_id: description: The list id for the abuse report. readOnly: true title: List ID type: string merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Abuse Complaint type: object application/problem+json: schema: description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id for the abuse report readOnly: true title: Campaign ID type: string date: description: Date for the abuse report readOnly: true title: Date type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The id for the abuse report readOnly: true title: Abuse Report ID type: integer list_id: description: The list id for the abuse report. readOnly: true title: List ID type: string merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Abuse Complaint 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 abuse report tags: - lists x-custom-config: methodNameCamel: getListAbuseReportDetails methodNameSnake: get_list_abuse_report_details "/lists/{list_id}/activity": get: deprecated: false description: Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity. operationId: getListsIdActivity 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: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID responses: "200": content: application/json: schema: description: Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: Recent list activity. items: description: One day's worth of list activity. Doesn't include Automation activity. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array day: description: The date for the activity summary. readOnly: true title: Day type: string emails_sent: description: The total number of emails sent on the date for the activity summary. readOnly: true title: Emails Sent type: integer hard_bounce: description: The number of hard bounces. readOnly: true title: Hard Bounces type: integer other_adds: description: The number of subscribers who may have been added outside of the [double opt-in process](https://mailchimp.com/help/about-double-opt-in/), such as imports or API activity. readOnly: true title: Other Adds type: integer other_removes: description: The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers). readOnly: true title: Other Removes type: integer recipient_clicks: description: The number of clicks. readOnly: true title: Recipient Clicks type: integer soft_bounce: description: The number of soft bounces readOnly: true title: Soft Bounces type: integer subs: description: The number of subscribes. readOnly: true title: Subscribes type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer unsubs: description: The number of unsubscribes. readOnly: true title: Unsubscribes type: integer title: Daily List Activity type: object title: List Activity type: array list_id: description: The unique id for the list. title: List 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: List Activity type: object application/problem+json: schema: description: Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: Recent list activity. items: description: One day's worth of list activity. Doesn't include Automation activity. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array day: description: The date for the activity summary. readOnly: true title: Day type: string emails_sent: description: The total number of emails sent on the date for the activity summary. readOnly: true title: Emails Sent type: integer hard_bounce: description: The number of hard bounces. readOnly: true title: Hard Bounces type: integer other_adds: description: The number of subscribers who may have been added outside of the [double opt-in process](https://mailchimp.com/help/about-double-opt-in/), such as imports or API activity. readOnly: true title: Other Adds type: integer other_removes: description: The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers). readOnly: true title: Other Removes type: integer recipient_clicks: description: The number of clicks. readOnly: true title: Recipient Clicks type: integer soft_bounce: description: The number of soft bounces readOnly: true title: Soft Bounces type: integer subs: description: The number of subscribes. readOnly: true title: Subscribes type: integer unique_opens: description: The number of unique opens. readOnly: true title: Unique Opens type: integer unsubs: description: The number of unsubscribes. readOnly: true title: Unsubscribes type: integer title: Daily List Activity type: object title: List Activity type: array list_id: description: The unique id for the list. title: List 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: List Activity 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 recent activity tags: - lists x-custom-config: methodNameCamel: getListRecentActivity methodNameSnake: get_list_recent_activity "/lists/{list_id}/clients": get: deprecated: false description: Get a list of the top email clients based on user-agent strings. operationId: getListsIdClients 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 list. in: path name: list_id required: true schema: type: string x-title: List ID responses: "200": content: application/json: schema: description: The top email clients based on user-agent strings. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array clients: description: An array of top email clients. items: description: The email client. properties: client: description: The name of the email client. readOnly: true title: Client type: string members: description: The number of subscribed members who used this email client. readOnly: true title: Members type: integer title: Email Client type: object title: Email Clients type: array list_id: description: The list id. readOnly: true title: List 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: Email Clients type: object application/problem+json: schema: description: The top email clients based on user-agent strings. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array clients: description: An array of top email clients. items: description: The email client. properties: client: description: The name of the email client. readOnly: true title: Client type: string members: description: The number of subscribed members who used this email client. readOnly: true title: Members type: integer title: Email Client type: object title: Email Clients type: array list_id: description: The list id. readOnly: true title: List 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: Email Clients 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 top email clients tags: - lists x-custom-config: methodNameCamel: getListClients methodNameSnake: get_list_clients "/lists/{list_id}/growth-history": get: deprecated: false description: Get a month-by-month summary of a specific list's growth activity. operationId: getListsIdGrowthHistory 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 unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - month 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: A month-by-month summary of a specific list's growth activity. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array history: description: An array of objects, each representing a monthly growth report for a list. items: description: A summary of a specific list's growth activity for a specific month and year. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array cleaned: description: Newly cleaned (hard-bounced) members on the list for a specific month. readOnly: true title: Cleaned type: integer deleted: description: Newly deleted members on the list for a specific month. readOnly: true title: Deleted type: integer existing: description: (deprecated) readOnly: true title: Existing type: integer imports: description: (deprecated) readOnly: true title: Imports type: integer list_id: description: The list id for the growth activity report. readOnly: true title: List ID type: string month: description: The month that the growth history is describing. readOnly: true title: Month type: string optins: description: (deprecated) readOnly: true title: Opt-in type: integer pending: description: Pending members on the list for a specific month. readOnly: true title: Pending type: integer reconfirm: description: Newly reconfirmed members on the list for a specific month. readOnly: true title: Reconfirm type: integer subscribed: description: Total subscribed members on the list at the end of the month. readOnly: true title: Subscribed type: integer transactional: description: Subscribers that have been sent transactional emails via Mandrill. readOnly: true title: Transactional type: integer unsubscribed: description: Newly unsubscribed members on the list for a specific month. readOnly: true title: Unsubscribed type: integer title: Growth History type: object title: Members type: array list_id: description: The list id. readOnly: true title: List 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: Growth History type: object application/problem+json: schema: description: A month-by-month summary of a specific list's growth activity. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array history: description: An array of objects, each representing a monthly growth report for a list. items: description: A summary of a specific list's growth activity for a specific month and year. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array cleaned: description: Newly cleaned (hard-bounced) members on the list for a specific month. readOnly: true title: Cleaned type: integer deleted: description: Newly deleted members on the list for a specific month. readOnly: true title: Deleted type: integer existing: description: (deprecated) readOnly: true title: Existing type: integer imports: description: (deprecated) readOnly: true title: Imports type: integer list_id: description: The list id for the growth activity report. readOnly: true title: List ID type: string month: description: The month that the growth history is describing. readOnly: true title: Month type: string optins: description: (deprecated) readOnly: true title: Opt-in type: integer pending: description: Pending members on the list for a specific month. readOnly: true title: Pending type: integer reconfirm: description: Newly reconfirmed members on the list for a specific month. readOnly: true title: Reconfirm type: integer subscribed: description: Total subscribed members on the list at the end of the month. readOnly: true title: Subscribed type: integer transactional: description: Subscribers that have been sent transactional emails via Mandrill. readOnly: true title: Transactional type: integer unsubscribed: description: Newly unsubscribed members on the list for a specific month. readOnly: true title: Unsubscribed type: integer title: Growth History type: object title: Members type: array list_id: description: The list id. readOnly: true title: List 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: Growth History 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 growth history data tags: - lists x-custom-config: methodNameCamel: getListGrowthHistory methodNameSnake: get_list_growth_history "/lists/{list_id}/growth-history/{month}": get: deprecated: false description: Get a summary of a specific list's growth activity for a specific month and year. operationId: getListsIdGrowthHistoryId 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 list. in: path name: list_id required: true schema: type: string x-title: List ID - description: A specific month of list growth history. in: path name: month required: true schema: type: string responses: "200": content: application/json: schema: description: A summary of a specific list's growth activity for a specific month and year. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array cleaned: description: Newly cleaned (hard-bounced) members on the list for a specific month. readOnly: true title: Cleaned type: integer deleted: description: Newly deleted members on the list for a specific month. readOnly: true title: Deleted type: integer existing: description: (deprecated) readOnly: true title: Existing type: integer imports: description: (deprecated) readOnly: true title: Imports type: integer list_id: description: The list id for the growth activity report. readOnly: true title: List ID type: string month: description: The month that the growth history is describing. readOnly: true title: Month type: string optins: description: (deprecated) readOnly: true title: Opt-in type: integer pending: description: Pending members on the list for a specific month. readOnly: true title: Pending type: integer reconfirm: description: Newly reconfirmed members on the list for a specific month. readOnly: true title: Reconfirm type: integer subscribed: description: Total subscribed members on the list at the end of the month. readOnly: true title: Subscribed type: integer transactional: description: Subscribers that have been sent transactional emails via Mandrill. readOnly: true title: Transactional type: integer unsubscribed: description: Newly unsubscribed members on the list for a specific month. readOnly: true title: Unsubscribed type: integer title: Growth History type: object application/problem+json: schema: description: A summary of a specific list's growth activity for a specific month and year. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array cleaned: description: Newly cleaned (hard-bounced) members on the list for a specific month. readOnly: true title: Cleaned type: integer deleted: description: Newly deleted members on the list for a specific month. readOnly: true title: Deleted type: integer existing: description: (deprecated) readOnly: true title: Existing type: integer imports: description: (deprecated) readOnly: true title: Imports type: integer list_id: description: The list id for the growth activity report. readOnly: true title: List ID type: string month: description: The month that the growth history is describing. readOnly: true title: Month type: string optins: description: (deprecated) readOnly: true title: Opt-in type: integer pending: description: Pending members on the list for a specific month. readOnly: true title: Pending type: integer reconfirm: description: Newly reconfirmed members on the list for a specific month. readOnly: true title: Reconfirm type: integer subscribed: description: Total subscribed members on the list at the end of the month. readOnly: true title: Subscribed type: integer transactional: description: Subscribers that have been sent transactional emails via Mandrill. readOnly: true title: Transactional type: integer unsubscribed: description: Newly unsubscribed members on the list for a specific month. readOnly: true title: Unsubscribed type: integer title: Growth History 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 growth history by month tags: - lists x-custom-config: methodNameCamel: getListGrowthHistoryByMonth methodNameSnake: get_list_growth_history_by_month "/lists/{list_id}/interest-categories": get: deprecated: false description: Get information about a list's interest categories. operationId: getListsIdInterestCategories parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - 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 a type of interest group in: query name: type required: false schema: type: string x-title: Interest Group Type responses: "200": content: application/json: schema: description: Information about this list's interest categories. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array categories: description: This array contains individual interest categories. items: description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the 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 display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer id: description: The id for the interest category. readOnly: true title: Category ID type: string list_id: description: The unique list id for the category. readOnly: true title: List ID type: string title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string title: Interest Category type: object title: Interest Categories type: array list_id: description: The ID for the list that this category belongs to. readOnly: true title: List 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: Interest Groupings type: object application/problem+json: schema: description: Information about this list's interest categories. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array categories: description: This array contains individual interest categories. items: description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the 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 display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer id: description: The id for the interest category. readOnly: true title: Category ID type: string list_id: description: The unique list id for the category. readOnly: true title: List ID type: string title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string title: Interest Category type: object title: Interest Categories type: array list_id: description: The ID for the list that this category belongs to. readOnly: true title: List 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: Interest Groupings 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 interest categories tags: - lists x-custom-config: methodNameCamel: getListInterestCategories methodNameSnake: get_list_interest_categories post: deprecated: false description: Create a new interest category. operationId: postListsIdInterestCategories parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID requestBody: $ref: "#/components/requestBodies/postListsIdInterestCategoriesBody" responses: "200": content: application/json: schema: description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the 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 display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer id: description: The id for the interest category. readOnly: true title: Category ID type: string list_id: description: The unique list id for the category. readOnly: true title: List ID type: string title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string title: Interest Category type: object application/problem+json: schema: description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the 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 display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer id: description: The id for the interest category. readOnly: true title: Category ID type: string list_id: description: The unique list id for the category. readOnly: true title: List ID type: string title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string title: Interest Category 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 interest category tags: - lists x-custom-config: methodNameCamel: createListInterestCategory methodNameSnake: create_list_interest_category "/lists/{list_id}/interest-categories/{interest_category_id}": delete: deprecated: false description: Delete a specific interest category. operationId: deleteListsIdInterestCategoriesId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique ID for the interest category. in: path name: interest_category_id required: true schema: type: string x-title: Interest Category 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 interest category tags: - lists x-custom-config: methodNameCamel: deleteInterestCategory methodNameSnake: delete_interest_category get: deprecated: false description: Get information about a specific interest category. operationId: getListsIdInterestCategoriesId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique ID for the interest category. in: path name: interest_category_id required: true schema: type: string x-title: Interest Category ID - 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: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the 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 display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer id: description: The id for the interest category. readOnly: true title: Category ID type: string list_id: description: The unique list id for the category. readOnly: true title: List ID type: string title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string title: Interest Category type: object application/problem+json: schema: description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the 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 display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer id: description: The id for the interest category. readOnly: true title: Category ID type: string list_id: description: The unique list id for the category. readOnly: true title: List ID type: string title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string title: Interest Category 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 interest category info tags: - lists x-custom-config: methodNameCamel: getInterestCategory methodNameSnake: get_interest_category patch: deprecated: false description: Update a specific interest category. operationId: patchListsIdInterestCategoriesId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique ID for the interest category. in: path name: interest_category_id required: true schema: type: string x-title: Interest Category ID requestBody: $ref: "#/components/requestBodies/postListsIdInterestCategoriesBody" responses: "200": content: application/json: schema: description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the 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 display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer id: description: The id for the interest category. readOnly: true title: Category ID type: string list_id: description: The unique list id for the category. readOnly: true title: List ID type: string title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string title: Interest Category type: object application/problem+json: schema: description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the 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 display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer id: description: The id for the interest category. readOnly: true title: Category ID type: string list_id: description: The unique list id for the category. readOnly: true title: List ID type: string title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string title: Interest Category 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 interest category tags: - lists x-custom-config: methodNameCamel: updateInterestCategory methodNameSnake: update_interest_category "/lists/{list_id}/interest-categories/{interest_category_id}/interests": get: deprecated: false description: Get a list of this category's interests. operationId: getListsIdInterestCategoriesIdInterests parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique ID for the interest category. in: path name: interest_category_id required: true schema: type: string x-title: Interest Category ID - 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 this category's interests properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array category_id: description: The id for the interest category. title: Interest Category ID type: string interests: description: An array of this category's interests items: description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp 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 category_id: description: The id for the interest category. readOnly: true title: Interest Category ID type: string display_order: description: The display order for interests. title: Display Order type: integer id: description: The ID for the interest. readOnly: true title: Interest ID type: string list_id: description: The ID for the list that this interest belongs to. readOnly: true title: List ID type: string name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string subscriber_count: description: The number of subscribers associated with this interest. readOnly: true title: Subscriber Count type: string title: Interest type: object title: Interests type: array list_id: description: The unique list id that the interests belong to. title: List 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: Interests type: object application/problem+json: schema: description: A list of this category's interests properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array category_id: description: The id for the interest category. title: Interest Category ID type: string interests: description: An array of this category's interests items: description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp 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 category_id: description: The id for the interest category. readOnly: true title: Interest Category ID type: string display_order: description: The display order for interests. title: Display Order type: integer id: description: The ID for the interest. readOnly: true title: Interest ID type: string list_id: description: The ID for the list that this interest belongs to. readOnly: true title: List ID type: string name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string subscriber_count: description: The number of subscribers associated with this interest. readOnly: true title: Subscriber Count type: string title: Interest type: object title: Interests type: array list_id: description: The unique list id that the interests belong to. title: List 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: Interests 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 interests in category tags: - lists x-custom-config: methodNameCamel: listInterestCategoryInterests methodNameSnake: list_interest_category_interests post: deprecated: false description: Create a new interest or 'group name' for a specific category. operationId: postListsIdInterestCategoriesIdInterests parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique ID for the interest category. in: path name: interest_category_id required: true schema: type: string x-title: Interest Category ID requestBody: $ref: "#/components/requestBodies/postListsIdInterestCategoriesIdInterestsBody" responses: "200": content: application/json: schema: description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp 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 category_id: description: The id for the interest category. readOnly: true title: Interest Category ID type: string display_order: description: The display order for interests. title: Display Order type: integer id: description: The ID for the interest. readOnly: true title: Interest ID type: string list_id: description: The ID for the list that this interest belongs to. readOnly: true title: List ID type: string name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string subscriber_count: description: The number of subscribers associated with this interest. readOnly: true title: Subscriber Count type: string title: Interest type: object application/problem+json: schema: description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp 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 category_id: description: The id for the interest category. readOnly: true title: Interest Category ID type: string display_order: description: The display order for interests. title: Display Order type: integer id: description: The ID for the interest. readOnly: true title: Interest ID type: string list_id: description: The ID for the list that this interest belongs to. readOnly: true title: List ID type: string name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string subscriber_count: description: The number of subscribers associated with this interest. readOnly: true title: Subscriber Count type: string title: Interest 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 interest in category tags: - lists x-custom-config: methodNameCamel: createInterestCategoryInterest methodNameSnake: create_interest_category_interest "/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}": delete: deprecated: false description: Delete interests or group names in a specific category. operationId: deleteListsIdInterestCategoriesIdInterestsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique ID for the interest category. in: path name: interest_category_id required: true schema: type: string x-title: Interest Category ID - description: The specific interest or 'group name'. in: path name: interest_id required: true schema: type: string x-title: Interest 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 interest in category tags: - lists x-custom-config: methodNameCamel: deleteInterestCategoryInterest methodNameSnake: delete_interest_category_interest get: deprecated: false description: Get interests or 'group names' for a specific category. operationId: getListsIdInterestCategoriesIdInterestsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique ID for the interest category. in: path name: interest_category_id required: true schema: type: string x-title: Interest Category ID - description: The specific interest or 'group name'. in: path name: interest_id required: true schema: type: string x-title: Interest ID - 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: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp 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 category_id: description: The id for the interest category. readOnly: true title: Interest Category ID type: string display_order: description: The display order for interests. title: Display Order type: integer id: description: The ID for the interest. readOnly: true title: Interest ID type: string list_id: description: The ID for the list that this interest belongs to. readOnly: true title: List ID type: string name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string subscriber_count: description: The number of subscribers associated with this interest. readOnly: true title: Subscriber Count type: string title: Interest type: object application/problem+json: schema: description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp 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 category_id: description: The id for the interest category. readOnly: true title: Interest Category ID type: string display_order: description: The display order for interests. title: Display Order type: integer id: description: The ID for the interest. readOnly: true title: Interest ID type: string list_id: description: The ID for the list that this interest belongs to. readOnly: true title: List ID type: string name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string subscriber_count: description: The number of subscribers associated with this interest. readOnly: true title: Subscriber Count type: string title: Interest 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 interest in category tags: - lists x-custom-config: methodNameCamel: getInterestCategoryInterest methodNameSnake: get_interest_category_interest patch: deprecated: false description: Update interests or 'group names' for a specific category. operationId: patchListsIdInterestCategoriesIdInterestsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique ID for the interest category. in: path name: interest_category_id required: true schema: type: string x-title: Interest Category ID - description: The specific interest or 'group name'. in: path name: interest_id required: true schema: type: string x-title: Interest ID requestBody: $ref: "#/components/requestBodies/postListsIdInterestCategoriesIdInterestsBody" responses: "200": content: application/json: schema: description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp 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 category_id: description: The id for the interest category. readOnly: true title: Interest Category ID type: string display_order: description: The display order for interests. title: Display Order type: integer id: description: The ID for the interest. readOnly: true title: Interest ID type: string list_id: description: The ID for the list that this interest belongs to. readOnly: true title: List ID type: string name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string subscriber_count: description: The number of subscribers associated with this interest. readOnly: true title: Subscriber Count type: string title: Interest type: object application/problem+json: schema: description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp 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 category_id: description: The id for the interest category. readOnly: true title: Interest Category ID type: string display_order: description: The display order for interests. title: Display Order type: integer id: description: The ID for the interest. readOnly: true title: Interest ID type: string list_id: description: The ID for the list that this interest belongs to. readOnly: true title: List ID type: string name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string subscriber_count: description: The number of subscribers associated with this interest. readOnly: true title: Subscriber Count type: string title: Interest 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 interest in category tags: - lists x-custom-config: methodNameCamel: updateInterestCategoryInterest methodNameSnake: update_interest_category_interest "/lists/{list_id}/locations": get: deprecated: false description: Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address. operationId: getListsIdLocations 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 list. in: path name: list_id required: true schema: type: string x-title: List ID responses: "200": content: application/json: schema: description: A summary of List's locations. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The unique id for the list. title: List ID type: string locations: description: An array of objects, each representing a list's top subscriber locations. items: properties: cc: description: The ISO 3166 2 digit country code. readOnly: true title: cc type: string country: description: The name of the country. readOnly: true title: Country Name type: string percent: description: The percent of subscribers in the country. readOnly: true title: percent type: number total: description: The total number of subscribers in the country. readOnly: true title: total type: integer title: List Location type: object title: Locations type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: List Locations type: object application/problem+json: schema: description: A summary of List's locations. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The unique id for the list. title: List ID type: string locations: description: An array of objects, each representing a list's top subscriber locations. items: properties: cc: description: The ISO 3166 2 digit country code. readOnly: true title: cc type: string country: description: The name of the country. readOnly: true title: Country Name type: string percent: description: The percent of subscribers in the country. readOnly: true title: percent type: number total: description: The total number of subscribers in the country. readOnly: true title: total type: integer title: List Location type: object title: Locations type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: List Locations 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 locations tags: - lists x-custom-config: methodNameCamel: getListLocations methodNameSnake: get_list_locations "/lists/{list_id}/members": get: deprecated: false description: Get information about members in a specific Mailchimp list. operationId: getListsIdMembers 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 unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The email type. in: query name: email_type required: false schema: type: string x-title: Email Type - description: The subscriber's status. in: query name: status required: false schema: enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived type: string x-title: Subscriber Status - description: "Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_timestamp_opt required: false schema: type: string x-title: Since Timestamp Opt - description: "Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_timestamp_opt required: false schema: type: string x-title: Before Timestamp Opt - description: "Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_last_changed required: false schema: type: string x-title: Since Last Changed - description: "Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_last_changed required: false schema: type: string x-title: Before Last Changed - description: A unique identifier for the email address across all Mailchimp lists. in: query name: unique_email_id required: false schema: type: string x-title: Unique Email ID - description: A filter to return only the list's VIP members. Passing `true` will restrict results to VIP list members, passing `false` will return all list members. in: query name: vip_only required: false schema: type: boolean x-title: VIP Only - description: The unique id for the interest category. in: query name: interest_category_id required: false schema: type: string x-title: Interest Category ID - description: Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories. in: query name: interest_ids required: false schema: type: string x-title: Interest Ids - description: Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. "any" will match a member with any of the interest supplied, "all" will only match members with every interest supplied, and "none" will match members without any of the interest supplied. in: query name: interest_match required: false schema: enum: - any - all - none type: string x-title: Interest Match - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - timestamp_opt - timestamp_signup - last_changed 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 - description: Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter. in: query name: since_last_campaign required: false schema: type: boolean x-title: Since Last Campaign - description: Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error. in: query name: unsubscribed_since required: false schema: type: string x-title: Unsubscribed Since responses: "200": content: application/json: schema: description: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. title: List ID type: string members: description: An array of objects, each representing a specific list member. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object title: Members type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: List Members type: object application/problem+json: schema: description: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. title: List ID type: string members: description: An array of objects, each representing a specific list member. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object title: Members type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: List Members 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 members info tags: - lists x-custom-config: methodNameCamel: getListMembersInfo methodNameSnake: get_list_members_info post: deprecated: false description: Add a new member to the list. operationId: postListsIdMembers parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. in: query name: skip_merge_validation required: false schema: type: boolean x-title: Skip Merge Validation requestBody: content: application/json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: description: Email address for a subscriber. title: Email Address type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string location: description: Subscriber location information. properties: latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string title: Marketing Permission type: object title: Marketing Permissions type: array merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags that are associated with a member. items: description: The name of the tag that will be associated with this member. type: string title: Tags on a member type: array timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time title: Signup Timestamp type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean required: - email_address - status title: Add List Members type: object required: true responses: "200": content: application/json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object application/problem+json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members 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 member to list tags: - lists x-custom-config: methodNameCamel: addListMember methodNameSnake: add_list_member "/lists/{list_id}/members/{subscriber_hash}": delete: deprecated: false description: Archive a list member. To permanently delete, use the delete-permanent action. operationId: deleteListsIdMembersId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash 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 list member tags: - lists x-custom-config: methodNameCamel: deleteListMember methodNameSnake: delete_list_member get: deprecated: false description: Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member. operationId: getListsIdMembersId 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 list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash responses: "200": content: application/json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object application/problem+json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members 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 member info tags: - lists x-custom-config: methodNameCamel: getListMember methodNameSnake: get_list_member patch: deprecated: false description: Update information for a specific list member. operationId: patchListsIdMembersId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. in: query name: skip_merge_validation required: false schema: type: boolean x-title: Skip Merge Validation requestBody: content: application/json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: description: Email address for a subscriber. title: Email Address type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string location: description: Subscriber location information. properties: latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string title: Marketing Permission type: object title: Marketing Permissions type: array merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending title: Status type: string timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time title: Signup Timestamp type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: Add List Members type: object required: true responses: "200": content: application/json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object application/problem+json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members 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 list member tags: - lists x-custom-config: methodNameCamel: updateListMember methodNameSnake: update_list_member put: deprecated: false description: Add or update a list member. operationId: putListsIdMembersId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. in: query name: skip_merge_validation required: false schema: type: boolean x-title: Skip Merge Validation requestBody: content: application/json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: description: Email address for a subscriber. This value is required only if the email address is not already present on the list. title: Email Address type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string location: description: Subscriber location information. properties: latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string title: Marketing Permission type: object title: Marketing Permissions type: array merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string status_if_new: description: Subscriber's status. This value is required only if the email address is not already present on the list. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: New Member Status type: string timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time title: Signup Timestamp type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean required: - email_address - status_if_new title: Add List Members type: object required: true responses: "200": content: application/json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object application/problem+json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members 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 list member tags: - lists x-custom-config: methodNameCamel: setListMember methodNameSnake: set_list_member "/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent": post: deprecated: false description: Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member. operationId: postListsIdMembersHashActionsDeletePermanent parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - 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: "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 list member tags: - lists x-custom-config: methodNameCamel: deleteListMemberPermanent methodNameSnake: delete_list_member_permanent "/lists/{list_id}/members/{subscriber_hash}/activity": get: deprecated: false description: Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes. operationId: getListsIdMembersIdActivity parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - 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: A comma seperated list of actions to return. explode: false in: query name: action required: false schema: enum: - - abuse - - bounce - - click - - open - - sent - - unsub - - ecomm items: type: string type: array style: form x-title: Action responses: "200": content: application/json: schema: description: The last 50 member events for a list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: An array of objects, each representing a member event. items: description: Member activity events. properties: action: description: The type of action recorded for the subscriber. title: Action Type type: string campaign_id: description: The web-based ID for the campaign. title: Campaign ID type: string parent_campaign: description: The ID of the parent campaign. title: Parent Campaign ID type: string timestamp: description: The date and time recorded for the action. format: date-time title: Timestamp type: string title: description: If set, the campaign's title. title: Campaign Title type: string type: description: The type of campaign that was sent. title: Campaign Type type: string url: description: For clicks, the URL the subscriber clicked on. title: URL type: string title: Member Activity type: object title: Activity type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_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: The list id. readOnly: true title: List 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: Member Activity Events type: object application/problem+json: schema: description: The last 50 member events for a list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: An array of objects, each representing a member event. items: description: Member activity events. properties: action: description: The type of action recorded for the subscriber. title: Action Type type: string campaign_id: description: The web-based ID for the campaign. title: Campaign ID type: string parent_campaign: description: The ID of the parent campaign. title: Parent Campaign ID type: string timestamp: description: The date and time recorded for the action. format: date-time title: Timestamp type: string title: description: If set, the campaign's title. title: Campaign Title type: string type: description: The type of campaign that was sent. title: Campaign Type type: string url: description: For clicks, the URL the subscriber clicked on. title: URL type: string title: Member Activity type: object title: Activity type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_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: The list id. readOnly: true title: List 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: Member Activity Events 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: View recent activity 50 tags: - lists x-custom-config: methodNameCamel: getListMemberActivity methodNameSnake: get_list_member_activity "/lists/{list_id}/members/{subscriber_hash}/activity-feed": get: deprecated: false description: Get a member's activity on a specific list, including opens, clicks, and unsubscribes. operationId: getListsIdMembersIdActivityFeed parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - 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 - 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: A comma-separated list of activity filters that correspond to a set of activity types, e.g "?activity_filters=open,bounce,click". explode: false in: query name: activity_filters required: false schema: enum: - - bounce - - click - - conversation - - ecommerce_signup - - event - - web_engagement - - generic_signup - - landing_page_signup - - marketing_permission - - note - - open - - order - - postcard_sent - - sent - - signup - - squatter_signup - - unsub - - website_signup - - survey_response items: type: string type: array style: form x-title: Activity Filters responses: "200": content: application/json: schema: description: The member activity events for a given member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas). items: discriminator: propertyName: activity_type type: string oneOf: - description: Activity feed item representing opening an email. properties: activity_type: description: The type of event activity. enum: - open type: string x-value: open campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string title: Email Opens type: object - description: Activity feed item representing having a link clicked by a contact. properties: activity_type: description: The type of event activity. enum: - click type: string x-value: click campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string link_clicked: description: The URL of the link that was clicked. title: Link Clicked type: string title: Email Clicks type: object - description: Activity feed item representing an email to this contact bouncing. properties: activity_type: description: The type of event activity. enum: - bounce type: string x-value: bounce bounce_has_open_activity: description: Indicates if the email associated with this bounce also has open activity on the same campaign. title: Bounce Has Open Activity type: boolean bounce_type: description: The type of bounce. enum: - hard - soft title: Bounce Type type: string campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string title: Email Bounced type: object - description: Activity feed item representing this contact unsubscribing from a list. properties: activity_type: description: The type of event activity. enum: - unsub type: string x-value: unsub campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Text type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string is_admin_unsubscribed: description: Indicates if an admin unsubscribed a contact. title: Is Admin Unsubscribed type: boolean unsubscribe_reason: description: Indicates the reason that the contact was unsubscribed. title: Unsubscribe Reason type: string title: List Unsubscribed type: object - description: Activity feed item representing having an email sent to the contact. properties: activity_type: description: The type of event activity. enum: - sent type: string x-value: sent campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string title: Email Sent type: object - description: Activity feed item representing an individual reply in a conversation. properties: activity_type: description: The type of event activity. enum: - conversation type: string x-value: conversation avatar_url: description: The gravatar URL of the contact who sent the reply. title: Avatar URL type: string campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string created_by: description: The username of the person who created this event. title: Created By type: string from_email: description: The email of the contact who sent the reply. title: From Email type: string has_read: description: Indicates that the message has been read. title: Has Read type: boolean is_user: description: Indicates that the message created by a user (as opposed to a contact). title: Is User type: boolean message_text: description: The body of the message in this conversation. title: Message Text type: string thread_id: description: The thread's unique id of the conversation referenced in this event. title: Thread ID type: string title: Email Conversation type: object - description: Activity feed item representing a note on the contact record. properties: activity_type: description: The type of event activity. enum: - note type: string x-value: note avatar_url: description: The URL of the contact's profile gravatar image. title: Avatar URL type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string created_by: description: The person who created the note. title: Created By type: string note_id: description: The note's unique id. title: Note ID type: string note_text: description: The note's text. title: Note Text type: string updated_at_timestamp: description: The updated at timestamp in ISO8601. format: date-time title: Updated At Timestamp type: string title: Note type: object - description: Activity feed item indicating if a marketing permission was added or updated. properties: activity_type: description: The type of event activity. enum: - marketing_permission type: string x-value: marketing_permission created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string marketing_permission_opted_in: description: Indicates if the marketing permission is enabled or not. title: Marketing Permission Opted In type: boolean marketing_permisson_text: description: The text describing this marketing permission. title: Marketing Permission Text type: string updated_by: description: The name of the contact who updated this permission. title: Updated By type: string title: Marketing Permission type: object - description: Activity feed item representing a time when a contact was sent a particular postcard. properties: activity_type: description: The type of event activity. enum: - postcard_sent type: string x-value: postcard_sent created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string title: Postcard Sent type: object - description: Activity feed item to representing a contact signing up for the audience from a squatter page. properties: activity_type: description: The type of event activity. enum: - squatter_signup type: string x-value: squatter_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string title: Squatter Signup type: object - description: Activity feed item to representing a contact signing up for the contact through a website page. properties: activity_type: description: The type of event activity. enum: - website_signup type: string x-value: website_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string title: Website Signup type: object - description: Activity feed item to representing a contact signing up for the list via a landing page. properties: activity_type: description: The type of event activity. enum: - landing_page_signup type: string x-value: landing_page_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string title: Landing Page Signup type: object - description: Activity feed item to representing a contact signing up for the list via a ecommerce store. properties: activity_type: description: The type of event activity. enum: - ecommerce_signup type: string x-value: ecommerce_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string store_name: description: The name of the store. title: Store Name type: string title: Ecommerce Signup type: object - description: Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to). properties: activity_type: description: The type of event activity. enum: - generic_signup type: string x-value: generic_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string signup_category: description: How was this user added to the list. title: Signup Category type: string title: Generic Signup type: object - description: Activity feed item that represents an order. properties: activity_type: description: The type of event activity. enum: - order type: string x-value: order created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string order_id: description: The unique order id. title: Order ID type: string order_items: description: An array of items that have been ordered. 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 Items type: array order_total: description: The order total formatted as a string. title: Order Total type: string order_url: description: The order URL. title: Order URL type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string outreach_type: description: The type of outreach that triggered the event. title: Outreach Type type: string store_name: description: The name of the store for an order. title: Store Name type: string title: Ecommerce Order type: object - description: Activity feed item that represents a generic event. properties: activity_type: description: The type of event activity. enum: - event type: string x-value: event created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string event_name: description: The name of the event. title: Event Name type: string event_properties: description: An arbitrary datastore containing properties for the given event. items: type: string x-skip-validation: true title: Event Properties type: array title: Contact Activity Event type: object - description: Represents when a contact completes and submits a survey properties: activity_type: description: The type of event activity. enum: - survey_response type: string x-value: survey_response created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string survey_id: description: The survey's unique id. title: Survey ID type: string survey_title: description: The title of the survey. title: Survey Title type: string title: Survey response type: object readOnly: true title: Activity type: array email_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: The list id. readOnly: true title: List ID type: string title: Member Activity Events type: object x-hidden: false application/problem+json: schema: description: The member activity events for a given member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas). items: discriminator: propertyName: activity_type type: string oneOf: - description: Activity feed item representing opening an email. properties: activity_type: description: The type of event activity. enum: - open type: string x-value: open campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string title: Email Opens type: object - description: Activity feed item representing having a link clicked by a contact. properties: activity_type: description: The type of event activity. enum: - click type: string x-value: click campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string link_clicked: description: The URL of the link that was clicked. title: Link Clicked type: string title: Email Clicks type: object - description: Activity feed item representing an email to this contact bouncing. properties: activity_type: description: The type of event activity. enum: - bounce type: string x-value: bounce bounce_has_open_activity: description: Indicates if the email associated with this bounce also has open activity on the same campaign. title: Bounce Has Open Activity type: boolean bounce_type: description: The type of bounce. enum: - hard - soft title: Bounce Type type: string campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string title: Email Bounced type: object - description: Activity feed item representing this contact unsubscribing from a list. properties: activity_type: description: The type of event activity. enum: - unsub type: string x-value: unsub campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Text type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string is_admin_unsubscribed: description: Indicates if an admin unsubscribed a contact. title: Is Admin Unsubscribed type: boolean unsubscribe_reason: description: Indicates the reason that the contact was unsubscribed. title: Unsubscribe Reason type: string title: List Unsubscribed type: object - description: Activity feed item representing having an email sent to the contact. properties: activity_type: description: The type of event activity. enum: - sent type: string x-value: sent campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string title: Email Sent type: object - description: Activity feed item representing an individual reply in a conversation. properties: activity_type: description: The type of event activity. enum: - conversation type: string x-value: conversation avatar_url: description: The gravatar URL of the contact who sent the reply. title: Avatar URL type: string campaign_id: description: The campaign's unique id. title: Campaign ID type: string campaign_title: description: The title of the campaign. title: Campaign Title type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string created_by: description: The username of the person who created this event. title: Created By type: string from_email: description: The email of the contact who sent the reply. title: From Email type: string has_read: description: Indicates that the message has been read. title: Has Read type: boolean is_user: description: Indicates that the message created by a user (as opposed to a contact). title: Is User type: boolean message_text: description: The body of the message in this conversation. title: Message Text type: string thread_id: description: The thread's unique id of the conversation referenced in this event. title: Thread ID type: string title: Email Conversation type: object - description: Activity feed item representing a note on the contact record. properties: activity_type: description: The type of event activity. enum: - note type: string x-value: note avatar_url: description: The URL of the contact's profile gravatar image. title: Avatar URL type: string created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string created_by: description: The person who created the note. title: Created By type: string note_id: description: The note's unique id. title: Note ID type: string note_text: description: The note's text. title: Note Text type: string updated_at_timestamp: description: The updated at timestamp in ISO8601. format: date-time title: Updated At Timestamp type: string title: Note type: object - description: Activity feed item indicating if a marketing permission was added or updated. properties: activity_type: description: The type of event activity. enum: - marketing_permission type: string x-value: marketing_permission created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string marketing_permission_opted_in: description: Indicates if the marketing permission is enabled or not. title: Marketing Permission Opted In type: boolean marketing_permisson_text: description: The text describing this marketing permission. title: Marketing Permission Text type: string updated_by: description: The name of the contact who updated this permission. title: Updated By type: string title: Marketing Permission type: object - description: Activity feed item representing a time when a contact was sent a particular postcard. properties: activity_type: description: The type of event activity. enum: - postcard_sent type: string x-value: postcard_sent created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string title: Postcard Sent type: object - description: Activity feed item to representing a contact signing up for the audience from a squatter page. properties: activity_type: description: The type of event activity. enum: - squatter_signup type: string x-value: squatter_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string title: Squatter Signup type: object - description: Activity feed item to representing a contact signing up for the contact through a website page. properties: activity_type: description: The type of event activity. enum: - website_signup type: string x-value: website_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string title: Website Signup type: object - description: Activity feed item to representing a contact signing up for the list via a landing page. properties: activity_type: description: The type of event activity. enum: - landing_page_signup type: string x-value: landing_page_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string title: Landing Page Signup type: object - description: Activity feed item to representing a contact signing up for the list via a ecommerce store. properties: activity_type: description: The type of event activity. enum: - ecommerce_signup type: string x-value: ecommerce_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string store_name: description: The name of the store. title: Store Name type: string title: Ecommerce Signup type: object - description: Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to). properties: activity_type: description: The type of event activity. enum: - generic_signup type: string x-value: generic_signup created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string signup_category: description: How was this user added to the list. title: Signup Category type: string title: Generic Signup type: object - description: Activity feed item that represents an order. properties: activity_type: description: The type of event activity. enum: - order type: string x-value: order created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string order_id: description: The unique order id. title: Order ID type: string order_items: description: An array of items that have been ordered. 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 Items type: array order_total: description: The order total formatted as a string. title: Order Total type: string order_url: description: The order URL. title: Order URL type: string outreach_id: description: The outreach's unique id. title: Outreach ID type: string outreach_title: description: The title of the outreach. title: Outreach Title type: string outreach_type: description: The type of outreach that triggered the event. title: Outreach Type type: string store_name: description: The name of the store for an order. title: Store Name type: string title: Ecommerce Order type: object - description: Activity feed item that represents a generic event. properties: activity_type: description: The type of event activity. enum: - event type: string x-value: event created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string event_name: description: The name of the event. title: Event Name type: string event_properties: description: An arbitrary datastore containing properties for the given event. items: type: string x-skip-validation: true title: Event Properties type: array title: Contact Activity Event type: object - description: Represents when a contact completes and submits a survey properties: activity_type: description: The type of event activity. enum: - survey_response type: string x-value: survey_response created_at_timestamp: description: The created at timestamp in ISO8601. format: date-time title: Created At Timestamp type: string survey_id: description: The survey's unique id. title: Survey ID type: string survey_title: description: The title of the survey. title: Survey Title type: string title: Survey response type: object readOnly: true title: Activity type: array email_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: The list id. readOnly: true title: List ID type: string title: Member Activity Events type: object x-hidden: false 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: View recent activity tags: - lists x-custom-config: methodNameCamel: getListMemberActivityFeed methodNameSnake: get_list_member_activity_feed "/lists/{list_id}/members/{subscriber_hash}/events": get: deprecated: false description: Get events for a contact. operationId: getListsIdMembersIdEvents parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - 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 responses: "200": content: application/json: schema: description: A collection of events for a given contact properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: An array of objects, each representing an event. items: description: A specific event for a contact. properties: name: description: The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length title: Event Name type: string occurred_at: description: The date and time the event occurred in ISO 8601 format. format: date-time readOnly: true title: Occurred Time type: string properties: additionalProperties: type: string description: An optional list of properties title: Properties type: object title: Event type: object title: Events 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 Events type: object application/problem+json: schema: description: A collection of events for a given contact properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: An array of objects, each representing an event. items: description: A specific event for a contact. properties: name: description: The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length title: Event Name type: string occurred_at: description: The date and time the event occurred in ISO 8601 format. format: date-time readOnly: true title: Occurred Time type: string properties: additionalProperties: type: string description: An optional list of properties title: Properties type: object title: Event type: object title: Events 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 Events 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 member events tags: - lists x-custom-config: methodNameCamel: getListMemberEvents methodNameSnake: get_list_member_events post: deprecated: false description: Add an event for a list member. operationId: postListMemberEvents parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash requestBody: content: application/json: schema: description: A new event for a specific list member properties: is_syncing: description: Events created with the is_syncing value set to `true` will not trigger automations. title: Is Syncing type: boolean name: description: The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length title: Event Name type: string occurred_at: description: The date and time the event occurred in ISO 8601 format. format: date-time title: Occurred Time type: string properties: additionalProperties: type: string description: An optional list of properties title: Properties type: object required: - name title: Events 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: Add event tags: - lists x-custom-config: methodNameCamel: createListMemberEvent methodNameSnake: create_list_member_event "/lists/{list_id}/members/{subscriber_hash}/goals": get: deprecated: false description: Get the last 50 Goal events for a member on a specific list. operationId: getListsIdMembersIdGoals parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - 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 last 50 Goal events for a member on a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string goals: description: The last 50 Goal events triggered by a member. items: description: A single instance of a goal activity. properties: data: description: Any extra data passed with the Goal event. title: Additional Data type: string event: description: The name/type of Goal event triggered. title: Event Name type: string goal_id: description: The id for a Goal event. title: Goal ID type: integer last_visited_at: description: The date and time the user last triggered the Goal event in ISO 8601 format. format: date-time title: Last Visit Date type: string title: Goal type: object title: Goal Activity type: array list_id: description: The list id. readOnly: true title: List 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: Collection of Member Activity Events type: object application/problem+json: schema: description: The last 50 Goal events for a member on a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string goals: description: The last 50 Goal events triggered by a member. items: description: A single instance of a goal activity. properties: data: description: Any extra data passed with the Goal event. title: Additional Data type: string event: description: The name/type of Goal event triggered. title: Event Name type: string goal_id: description: The id for a Goal event. title: Goal ID type: integer last_visited_at: description: The date and time the user last triggered the Goal event in ISO 8601 format. format: date-time title: Last Visit Date type: string title: Goal type: object title: Goal Activity type: array list_id: description: The list id. readOnly: true title: List 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: Collection of Member Activity Events 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 member goal events tags: - lists x-custom-config: methodNameCamel: getListMemberGoals methodNameSnake: getListMemberGoals "/lists/{list_id}/members/{subscriber_hash}/notes": get: deprecated: false description: Get recent notes for a specific list member. operationId: getListsIdMembersIdNotes parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - 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 - description: Returns notes sorted by the specified field. in: query name: sort_field required: false schema: enum: - created_at - updated_at - note_id 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 - 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: The last 10 notes for a specific list member, based on date created. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: The list id. readOnly: true title: List ID type: string notes: description: An array of objects, each representing a note resource. items: description: A specific note for a specific member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The note id. readOnly: true title: Note ID type: integer list_id: description: The unique id for the list. readOnly: true title: List ID type: string note: description: The content of the note. title: Note type: string updated_at: description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated Time type: string title: Member Notes type: object title: Notes 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 Notes type: object application/problem+json: schema: description: The last 10 notes for a specific list member, based on date created. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string list_id: description: The list id. readOnly: true title: List ID type: string notes: description: An array of objects, each representing a note resource. items: description: A specific note for a specific member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The note id. readOnly: true title: Note ID type: integer list_id: description: The unique id for the list. readOnly: true title: List ID type: string note: description: The content of the note. title: Note type: string updated_at: description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated Time type: string title: Member Notes type: object title: Notes 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 Notes 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 recent member notes tags: - lists x-custom-config: methodNameCamel: getListMemberNotes methodNameSnake: get_list_member_notes post: deprecated: false description: Add a new note for a specific subscriber. operationId: postListsIdMembersIdNotes parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - 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 requestBody: $ref: "#/components/requestBodies/postListsIdMembersIdNotesBody" responses: "200": content: application/json: schema: description: A specific note for a specific member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The note id. readOnly: true title: Note ID type: integer list_id: description: The unique id for the list. readOnly: true title: List ID type: string note: description: The content of the note. title: Note type: string updated_at: description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated Time type: string title: Member Notes type: object application/problem+json: schema: description: A specific note for a specific member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The note id. readOnly: true title: Note ID type: integer list_id: description: The unique id for the list. readOnly: true title: List ID type: string note: description: The content of the note. title: Note type: string updated_at: description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated Time type: string title: Member Notes 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 member note tags: - lists x-custom-config: methodNameCamel: createListMemberNote methodNameSnake: create_list_member_note "/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}": delete: deprecated: false description: Delete a specific note for a specific list member. operationId: deleteListsIdMembersIdNotesId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - description: The id for the note. in: path name: note_id required: true schema: type: string x-title: Note 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 note tags: - lists x-custom-config: methodNameCamel: deleteListMemberNote methodNameSnake: delete_list_member_note get: deprecated: false description: Get a specific note for a specific list member. operationId: getListsIdMembersIdNotesId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - description: The id for the note. in: path name: note_id required: true schema: type: string x-title: Note ID - 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: A specific note for a specific member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The note id. readOnly: true title: Note ID type: integer list_id: description: The unique id for the list. readOnly: true title: List ID type: string note: description: The content of the note. title: Note type: string updated_at: description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated Time type: string title: Member Notes type: object application/problem+json: schema: description: A specific note for a specific member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The note id. readOnly: true title: Note ID type: integer list_id: description: The unique id for the list. readOnly: true title: List ID type: string note: description: The content of the note. title: Note type: string updated_at: description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated Time type: string title: Member Notes 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 member note tags: - lists x-custom-config: methodNameCamel: getListMemberNote methodNameSnake: get_list_member_note patch: deprecated: false description: Update a specific note for a specific list member. operationId: patchListsIdMembersIdNotesId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - description: The id for the note. in: path name: note_id required: true schema: type: string x-title: Note ID requestBody: $ref: "#/components/requestBodies/postListsIdMembersIdNotesBody" responses: "200": content: application/json: schema: description: A specific note for a specific member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The note id. readOnly: true title: Note ID type: integer list_id: description: The unique id for the list. readOnly: true title: List ID type: string note: description: The content of the note. title: Note type: string updated_at: description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated Time type: string title: Member Notes type: object application/problem+json: schema: description: A specific note for a specific member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The note id. readOnly: true title: Note ID type: integer list_id: description: The unique id for the list. readOnly: true title: List ID type: string note: description: The content of the note. title: Note type: string updated_at: description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true title: Updated Time type: string title: Member Notes 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 note tags: - lists x-custom-config: methodNameCamel: updateListMemberNote methodNameSnake: update_list_member_note "/lists/{list_id}/members/{subscriber_hash}/tags": get: deprecated: false description: Get the tags on a list member. operationId: getListMemberTags parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. in: path name: subscriber_hash required: true schema: type: string x-title: Subscriber Hash - 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 tags assigned to a list member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array tags: description: A list of tags assigned to the list member. items: properties: date_added: description: The date and time the tag was added to the list member in ISO 8601 format. format: date-time readOnly: true title: Date Added type: string id: description: The unique id for the tag. readOnly: true title: Tag ID type: integer name: description: The name of the tag. title: Tag Name type: string readOnly: false title: Tags 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 Tags type: object application/problem+json: schema: description: A list of tags assigned to a list member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array tags: description: A list of tags assigned to the list member. items: properties: date_added: description: The date and time the tag was added to the list member in ISO 8601 format. format: date-time readOnly: true title: Date Added type: string id: description: The unique id for the tag. readOnly: true title: Tag ID type: integer name: description: The name of the tag. title: Tag Name type: string readOnly: false title: Tags 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 Tags 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 member tags tags: - lists x-custom-config: methodNameCamel: getListMemberTags methodNameSnake: get_list_member_tags post: deprecated: false description: Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created. operationId: postListMemberTags parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - 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 requestBody: content: application/json: schema: description: A list of tags assigned to a list member. properties: is_syncing: description: When is_syncing is true, automations based on the tags in the request will not fire title: Is Syncing type: boolean tags: description: A list of tags assigned to the list member. items: description: Add or remove tags on a member by declaring a tag either active or inactive on a member. properties: name: description: The name of the tag. title: Tag Name type: string status: description: The status for the tag on the member, pass in active to add a tag or inactive to remove it. enum: - inactive - active title: Status type: string required: - name - status title: Member Tag type: object title: Tags type: array required: - tags title: Member Tags 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: Add or remove member tags tags: - lists x-custom-config: methodNameCamel: updateListMemberTags methodNameSnake: update_list_member_tags "/lists/{list_id}/merge-fields": get: deprecated: false description: Get a list of all merge fields for an audience. operationId: getListsIdMergeFields parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - 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 merge field type. in: query name: type required: false schema: type: string x-title: Merge Type - description: Whether it's a required merge field. in: query name: required required: false schema: type: boolean x-title: Required responses: "200": content: application/json: schema: description: The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. readOnly: true title: List ID type: string merge_fields: description: An array of objects, each representing a merge field resource. items: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string list_id: description: The ID that identifies this merge field's audience'. readOnly: true title: List ID type: string merge_id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. readOnly: true title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: The boolean value if the merge field is required. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string title: Merge Field type: object title: Merge Fields 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 Merge Fields type: object application/problem+json: schema: description: The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. readOnly: true title: List ID type: string merge_fields: description: An array of objects, each representing a merge field resource. items: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string list_id: description: The ID that identifies this merge field's audience'. readOnly: true title: List ID type: string merge_id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. readOnly: true title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: The boolean value if the merge field is required. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string title: Merge Field type: object title: Merge Fields 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 Merge Fields 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 merge fields tags: - lists x-custom-config: methodNameCamel: getListMergeFields methodNameSnake: get_list_merge_fields post: deprecated: false description: Add a new merge field for a specific audience. operationId: postListsIdMergeFields parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID requestBody: content: application/json: schema: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. items: type: string title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: Whether the merge field is required to import a contact. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip title: Merge Field Type type: string required: - name - type title: Merge Field type: object required: true responses: "200": content: application/json: schema: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string list_id: description: The ID that identifies this merge field's audience'. readOnly: true title: List ID type: string merge_id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. readOnly: true title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: The boolean value if the merge field is required. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string title: Merge Field type: object application/problem+json: schema: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string list_id: description: The ID that identifies this merge field's audience'. readOnly: true title: List ID type: string merge_id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. readOnly: true title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: The boolean value if the merge field is required. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string title: Merge Field 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 merge field tags: - lists x-custom-config: methodNameCamel: addListMergeField methodNameSnake: add_list_merge_field "/lists/{list_id}/merge-fields/{merge_id}": delete: deprecated: false description: Delete a specific merge field. operationId: deleteListsIdMergeFieldsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The id for the merge field. in: path name: merge_id required: true schema: type: string x-title: Merge 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 merge field tags: - lists x-custom-config: methodNameCamel: deleteListMergeField methodNameSnake: delete_list_merge_field get: deprecated: false description: Get information about a specific merge field. operationId: getListsIdMergeFieldsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The id for the merge field. in: path name: merge_id required: true schema: type: string x-title: Merge ID - 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: 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 responses: "200": content: application/json: schema: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string list_id: description: The ID that identifies this merge field's audience'. readOnly: true title: List ID type: string merge_id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. readOnly: true title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: The boolean value if the merge field is required. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string title: Merge Field type: object application/problem+json: schema: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string list_id: description: The ID that identifies this merge field's audience'. readOnly: true title: List ID type: string merge_id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. readOnly: true title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: The boolean value if the merge field is required. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string title: Merge Field 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 merge field tags: - lists x-custom-config: methodNameCamel: getListMergeField methodNameSnake: get_list_merge_field patch: deprecated: false description: Update a specific merge field. operationId: patchListsIdMergeFieldsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The id for the merge field. in: path name: merge_id required: true schema: type: string x-title: Merge ID requestBody: content: application/json: schema: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for members to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: Whether the merge field is required to import a contact. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string required: - name title: Merge Field type: object required: true responses: "200": content: application/json: schema: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string list_id: description: The ID that identifies this merge field's audience'. readOnly: true title: List ID type: string merge_id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. readOnly: true title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: The boolean value if the merge field is required. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string title: Merge Field type: object application/problem+json: schema: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array default_value: description: The default value for the merge field if `null`. title: Default Value type: string display_order: description: The order that the merge field displays on the list signup form. title: Display Order type: integer help_text: description: Extra text to help the subscriber fill out the form. title: Merge Field Help Text type: string list_id: description: The ID that identifies this merge field's audience'. readOnly: true title: List ID type: string merge_id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer name: description: The name of the merge field (audience field). title: Merge Field Name type: string options: description: Extra options for some merge field types. properties: choices: description: In a radio or dropdown non-group field, the available options for contacts to pick from. example: - First Choice - Second Choice - Third Choice items: type: string title: Choices type: array date_format: description: In a date or birthday field, the format of the date. title: Date Type type: string default_country: description: In an address field, the default country code if none supplied. title: Default Country type: integer phone_format: description: "In a phone field, the phone number type: US or International." title: Phone Type type: string size: description: In a text field, the default length of the text field. readOnly: true title: Text Field Size type: integer title: Merge Field Options type: object public: description: Whether the merge field is displayed on the signup form. title: Merge Field Public Status type: boolean required: description: The boolean value if the merge field is required. title: Required type: boolean tag: description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). title: Merge Tag type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string title: Merge Field 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 merge field tags: - lists x-custom-config: methodNameCamel: updateListMergeField methodNameSnake: update_list_merge_field "/lists/{list_id}/segments": get: deprecated: false description: Get information about all available segments for a specific list. operationId: previewASegment 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 unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: Limit results based on segment type. in: query name: type required: false schema: type: string x-title: Segment Type - description: "Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_created_at required: false schema: type: string x-title: Since Created At - description: "Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_created_at required: false schema: type: string x-title: Before Created At - description: Include cleaned members in response example: false in: query name: include_cleaned required: false schema: type: boolean x-title: Include Cleaned - description: Include transactional members in response example: false in: query name: include_transactional required: false schema: type: boolean x-title: Include Transactional - description: Include unsubscribed members in response example: false in: query name: include_unsubscribed required: false schema: type: boolean x-title: Include Unsubscribed - description: "Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_updated_at required: false schema: type: string x-title: Since Updated At - description: "Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_updated_at required: false schema: type: string x-title: Before Updated At responses: "200": content: application/json: schema: description: A list of available segments. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. readOnly: true title: List ID type: string segments: description: An array of objects, each representing a list segment. items: description: Information about a specific segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 segment was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string id: description: The unique id for the segment. readOnly: true title: Segment ID type: integer list_id: description: The list id. readOnly: true title: List ID type: string member_count: description: The number of active subscribers currently included in the segment. readOnly: true title: Member Count type: integer name: description: The name of the segment. title: Segment Name type: string options: description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object type: description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). enum: - saved - static - fuzzy readOnly: true title: Type type: string updated_at: description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true title: Date Updated type: string title: List type: object title: Lists 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 Segments type: object application/problem+json: schema: description: A list of available segments. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. readOnly: true title: List ID type: string segments: description: An array of objects, each representing a list segment. items: description: Information about a specific segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 segment was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string id: description: The unique id for the segment. readOnly: true title: Segment ID type: integer list_id: description: The list id. readOnly: true title: List ID type: string member_count: description: The number of active subscribers currently included in the segment. readOnly: true title: Member Count type: integer name: description: The name of the segment. title: Segment Name type: string options: description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object type: description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). enum: - saved - static - fuzzy readOnly: true title: Type type: string updated_at: description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true title: Date Updated type: string title: List type: object title: Lists 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 Segments 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 segments tags: - lists x-custom-config: methodNameCamel: listSegments methodNameSnake: list_segments post: deprecated: false description: Create a new segment in a specific list. operationId: postListsIdSegments parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID requestBody: content: application/json: schema: description: Information about a specific list segment. properties: name: description: The name of the segment. title: Segment Name type: string options: description: The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object static_segment: description: An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field. items: type: string title: Static Segment type: array required: - name title: List type: object required: true responses: "200": content: application/json: schema: description: Information about a specific segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 segment was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string id: description: The unique id for the segment. readOnly: true title: Segment ID type: integer list_id: description: The list id. readOnly: true title: List ID type: string member_count: description: The number of active subscribers currently included in the segment. readOnly: true title: Member Count type: integer name: description: The name of the segment. title: Segment Name type: string options: description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object type: description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). enum: - saved - static - fuzzy readOnly: true title: Type type: string updated_at: description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true title: Date Updated type: string title: List type: object application/problem+json: schema: description: Information about a specific segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 segment was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string id: description: The unique id for the segment. readOnly: true title: Segment ID type: integer list_id: description: The list id. readOnly: true title: List ID type: string member_count: description: The number of active subscribers currently included in the segment. readOnly: true title: Member Count type: integer name: description: The name of the segment. title: Segment Name type: string options: description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object type: description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). enum: - saved - static - fuzzy readOnly: true title: Type type: string updated_at: description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true title: Date Updated type: string title: List 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 segment tags: - lists x-custom-config: methodNameCamel: createSegment methodNameSnake: create_segment "/lists/{list_id}/segments/{segment_id}": delete: deprecated: false description: Delete a specific segment in a list. operationId: deleteListsIdSegmentsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique id for the segment. in: path name: segment_id required: true schema: type: string x-title: Segment 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 segment tags: - lists x-custom-config: methodNameCamel: deleteSegment methodNameSnake: delete_segment get: deprecated: false description: Get information about a specific segment. operationId: getListsIdSegmentsId 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 list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique id for the segment. in: path name: segment_id required: true schema: type: string x-title: Segment ID - description: Include cleaned members in response example: false in: query name: include_cleaned required: false schema: type: boolean x-title: Include Cleaned - description: Include transactional members in response example: false in: query name: include_transactional required: false schema: type: boolean x-title: Include Transactional - description: Include unsubscribed members in response example: false in: query name: include_unsubscribed required: false schema: type: boolean x-title: Include Unsubscribed responses: "200": content: application/json: schema: description: Information about a specific segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 segment was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string id: description: The unique id for the segment. readOnly: true title: Segment ID type: integer list_id: description: The list id. readOnly: true title: List ID type: string member_count: description: The number of active subscribers currently included in the segment. readOnly: true title: Member Count type: integer name: description: The name of the segment. title: Segment Name type: string options: description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object type: description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). enum: - saved - static - fuzzy readOnly: true title: Type type: string updated_at: description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true title: Date Updated type: string title: List type: object application/problem+json: schema: description: Information about a specific segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 segment was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string id: description: The unique id for the segment. readOnly: true title: Segment ID type: integer list_id: description: The list id. readOnly: true title: List ID type: string member_count: description: The number of active subscribers currently included in the segment. readOnly: true title: Member Count type: integer name: description: The name of the segment. title: Segment Name type: string options: description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object type: description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). enum: - saved - static - fuzzy readOnly: true title: Type type: string updated_at: description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true title: Date Updated type: string title: List 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 segment info tags: - lists x-custom-config: methodNameCamel: getSegment methodNameSnake: get_segment patch: deprecated: false description: Update a specific segment in a list. operationId: patchListsIdSegmentsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique id for the segment. in: path name: segment_id required: true schema: type: string x-title: Segment ID requestBody: content: application/json: schema: description: Information about a specific list segment. properties: name: description: The name of the segment. title: Segment Name type: string options: description: The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions. properties: conditions: description: An array of segment conditions. items: 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 title: Segment Conditions type: array match: description: Match type. enum: - any - all title: Match type: string title: Conditions type: object static_segment: description: An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the `options` field. items: type: string title: Static Segment type: array required: - name title: List type: object required: true responses: "200": content: application/json: schema: description: Information about a specific segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 segment was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string id: description: The unique id for the segment. readOnly: true title: Segment ID type: integer list_id: description: The list id. readOnly: true title: List ID type: string member_count: description: The number of active subscribers currently included in the segment. readOnly: true title: Member Count type: integer name: description: The name of the segment. title: Segment Name type: string options: description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object type: description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). enum: - saved - static - fuzzy readOnly: true title: Type type: string updated_at: description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true title: Date Updated type: string title: List type: object application/problem+json: schema: description: Information about a specific segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 segment was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string id: description: The unique id for the segment. readOnly: true title: Segment ID type: integer list_id: description: The list id. readOnly: true title: List ID type: string member_count: description: The number of active subscribers currently included in the segment. readOnly: true title: Member Count type: integer name: description: The name of the segment. title: Segment Name type: string options: description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. 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: Match type. enum: - any - all title: Match type: string title: Conditions type: object type: description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). enum: - saved - static - fuzzy readOnly: true title: Type type: string updated_at: description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true title: Date Updated type: string title: List 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 segment tags: - lists x-custom-config: methodNameCamel: updateSegment methodNameSnake: update_segment post: deprecated: false description: Batch add/remove list members to static segment operationId: postListsIdSegmentsId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique id for the segment. in: path name: segment_id required: true schema: type: string x-title: Segment ID requestBody: content: application/json: schema: description: Members to add/remove to/from a static segment properties: members_to_add: description: An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent. items: type: string title: Members to add to the static segment type: array members_to_remove: description: An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent. items: type: string title: Members to remove from the static segment type: array title: Members to add/remove to/from a static segment type: object required: true responses: "200": content: application/json: schema: description: Batch add/remove List members to/from static segment properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array error_count: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer errors: description: An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details. items: properties: email_addresses: description: Email addresses added to the static segment or removed items: type: string title: Email addresses added to the static segment or removed type: array error: description: The error message indicating why the email addresses could not be added or updated. title: Error message type: string type: object title: Errors type: array members_added: description: An array of objects, each representing a new member that was added to the static segment. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: An individual merge var and value for a member. title: Member Merge Var type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags applied to this member. items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: Members Added type: array members_removed: description: An array of objects, each representing an existing list member that got deleted from the static segment. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: An individual merge var and value for a member. title: Member Merge Var type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags applied to this member. items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: Members Removed type: array total_added: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer total_removed: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer title: Batch add/remove List members to/from static segment type: object application/problem+json: schema: description: Batch add/remove List members to/from static segment properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array error_count: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer errors: description: An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details. items: properties: email_addresses: description: Email addresses added to the static segment or removed items: type: string title: Email addresses added to the static segment or removed type: array error: description: The error message indicating why the email addresses could not be added or updated. title: Error message type: string type: object title: Errors type: array members_added: description: An array of objects, each representing a new member that was added to the static segment. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: An individual merge var and value for a member. title: Member Merge Var type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags applied to this member. items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: Members Added type: array members_removed: description: An array of objects, each representing an existing list member that got deleted from the static segment. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: An individual merge var and value for a member. title: Member Merge Var type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string tags: description: The tags applied to this member. items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: Members Removed type: array total_added: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer total_removed: description: The total number of items matching the query, irrespective of pagination. example: 42 title: Item Count type: integer title: Batch add/remove List members to/from static segment 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: Batch add or remove members tags: - lists x-custom-config: methodNameCamel: batchSegmentMembers methodNameSnake: batch_segment_members "/lists/{list_id}/segments/{segment_id}/members": get: deprecated: false description: Get information about members in a saved segment. operationId: getListsIdSegmentsIdMembers 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 unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique id for the segment. in: path name: segment_id required: true schema: type: string x-title: Segment ID - description: Include cleaned members in response example: false in: query name: include_cleaned required: false schema: type: boolean x-title: Include Cleaned - description: Include transactional members in response example: false in: query name: include_transactional required: false schema: type: boolean x-title: Include Transactional - description: Include unsubscribed members in response example: false in: query name: include_unsubscribed required: false schema: type: boolean x-title: Include Unsubscribed responses: "200": content: application/json: schema: description: View members in a specific list segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array members: description: An array of objects, each representing a specific list member. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. readOnly: true title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: Members type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Segment Members type: object application/problem+json: schema: description: View members in a specific list segment. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array members: description: An array of objects, each representing a specific list member. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. readOnly: true title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object title: Members type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Segment Members 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 members in segment tags: - lists x-custom-config: methodNameCamel: getSegmentMembersList methodNameSnake: get_segment_members_list post: deprecated: false description: Add a member to a static segment. operationId: postListsIdSegmentsIdMembers parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique id for the segment. in: path name: segment_id required: true schema: type: string x-title: Segment ID requestBody: content: application/json: schema: properties: email_address: description: Email address for a subscriber. title: Email Address type: string required: - email_address type: object required: true responses: "200": content: application/json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. readOnly: true title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members type: object application/problem+json: schema: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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: Email address for a subscriber. readOnly: true title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional title: Status type: string timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean title: List Members 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 member to segment tags: - lists x-custom-config: methodNameCamel: createSegmentMember methodNameSnake: create_segment_member "/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}": delete: deprecated: false description: Remove a member from the specified static segment. operationId: deleteListsIdSegmentsIdMembersId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The unique id for the segment. in: path name: segment_id required: true schema: type: string x-title: Segment ID - 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: "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: Remove list member from segment tags: - lists x-custom-config: methodNameCamel: removeSegmentMember methodNameSnake: remove_segment_member "/lists/{list_id}/signup-forms": get: deprecated: false description: Get signup forms for a specific list. operationId: getListsIdSignupForms parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID responses: "200": content: application/json: schema: description: List Signup Forms. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. title: List ID type: string signup_forms: description: List signup form. items: description: List signup form. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contents: description: The signup form body content. items: description: Collection of Content for List Signup Forms. properties: section: description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message title: Content Section Name type: string value: description: The content section text. example: Signup message goes here title: Content Section Value type: string title: Collection of Content for List Signup Forms type: object title: Signup form body content type: array header: description: Options for customizing your signup form header. properties: image_align: description: Image alignment. enum: - none - left - center - right example: center title: Image align type: string image_alt: description: Alt text for the image. example: This is an image title: Image Alt type: string image_border_color: description: Image border color. example: "#896d6d" title: Image border color type: string image_border_style: description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid title: Image border style type: string image_border_width: description: Image border width. example: "2" title: Image border width type: string image_height: description: Image height, in pixels. example: "200" title: Image height type: string image_link: description: The URL that the header image will link to. example: gotothisimage.com title: Image Link type: string image_target: description: Image link target. enum: - _blank - "null" example: _blank title: Image target type: string image_url: description: Header image URL. example: http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png title: Header Image URL type: string image_width: description: Image width, in pixels. example: "800" title: Image width type: string text: description: Header text. example: Header Text goes here title: Header Text type: string title: Signup form header options type: object list_id: description: The signup form's list id. example: 4ca5becb8d readOnly: true title: List ID type: string signup_form_url: description: Signup form URL. title: Signup form URL type: string styles: description: An array of objects, each representing an element style for the signup form. items: description: Collection of Element style for List Signup Forms. properties: options: description: A collection of options for a selector. items: description: An option for Signup Form Styles. properties: property: description: A string that identifies the property. example: background-color title: Property type: string value: description: A string that identifies value of the property. example: "#111111" title: Value type: string title: An option for Signup Form Styles type: object title: Options type: array selector: description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background title: Selector type: string title: Collection of Element style for List Signup Forms type: object title: Signup Form element style type: array title: Signup Form type: object title: List Signup Form type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: List Signup Forms type: object application/problem+json: schema: description: List Signup Forms. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. title: List ID type: string signup_forms: description: List signup form. items: description: List signup form. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contents: description: The signup form body content. items: description: Collection of Content for List Signup Forms. properties: section: description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message title: Content Section Name type: string value: description: The content section text. example: Signup message goes here title: Content Section Value type: string title: Collection of Content for List Signup Forms type: object title: Signup form body content type: array header: description: Options for customizing your signup form header. properties: image_align: description: Image alignment. enum: - none - left - center - right example: center title: Image align type: string image_alt: description: Alt text for the image. example: This is an image title: Image Alt type: string image_border_color: description: Image border color. example: "#896d6d" title: Image border color type: string image_border_style: description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid title: Image border style type: string image_border_width: description: Image border width. example: "2" title: Image border width type: string image_height: description: Image height, in pixels. example: "200" title: Image height type: string image_link: description: The URL that the header image will link to. example: gotothisimage.com title: Image Link type: string image_target: description: Image link target. enum: - _blank - "null" example: _blank title: Image target type: string image_url: description: Header image URL. example: http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png title: Header Image URL type: string image_width: description: Image width, in pixels. example: "800" title: Image width type: string text: description: Header text. example: Header Text goes here title: Header Text type: string title: Signup form header options type: object list_id: description: The signup form's list id. example: 4ca5becb8d readOnly: true title: List ID type: string signup_form_url: description: Signup form URL. title: Signup form URL type: string styles: description: An array of objects, each representing an element style for the signup form. items: description: Collection of Element style for List Signup Forms. properties: options: description: A collection of options for a selector. items: description: An option for Signup Form Styles. properties: property: description: A string that identifies the property. example: background-color title: Property type: string value: description: A string that identifies value of the property. example: "#111111" title: Value type: string title: An option for Signup Form Styles type: object title: Options type: array selector: description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background title: Selector type: string title: Collection of Element style for List Signup Forms type: object title: Signup Form element style type: array title: Signup Form type: object title: List Signup Form type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: List Signup Forms 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 signup forms tags: - lists x-custom-config: methodNameCamel: getListSignupForms methodNameSnake: get_list_signup_forms post: deprecated: false description: Customize a list's default signup form. operationId: postListsIdSignupForms parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID requestBody: content: application/json: schema: description: List signup form. properties: contents: description: The signup form body content. items: description: Collection of Content for List Signup Forms. properties: section: description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message title: Content Section Name type: string value: description: The content section text. example: Signup message goes here title: Content Section Value type: string title: Collection of Content for List Signup Forms type: object title: Signup form body content type: array header: description: Options for customizing your signup form header. properties: image_align: description: Image alignment. enum: - none - left - center - right example: center title: Image align type: string image_alt: description: Alt text for the image. example: This is an image title: Image Alt type: string image_border_color: description: Image border color. example: "#896d6d" title: Image border color type: string image_border_style: description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid title: Image border style type: string image_border_width: description: Image border width. example: "2" title: Image border width type: string image_height: description: Image height, in pixels. example: "200" title: Image height type: string image_link: description: The URL that the header image will link to. example: gotothisimage.com title: Image Link type: string image_target: description: Image link target. enum: - _blank - "null" example: _blank title: Image target type: string image_url: description: Header image URL. example: http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png title: Header Image URL type: string image_width: description: Image width, in pixels. example: "800" title: Image width type: string text: description: Header text. example: Header Text goes here title: Header Text type: string title: Signup form header options type: object styles: description: An array of objects, each representing an element style for the signup form. items: description: Collection of Element style for List Signup Forms. properties: options: description: A collection of options for a selector. items: description: An option for Signup Form Styles. properties: property: description: A string that identifies the property. example: background-color title: Property type: string value: description: A string that identifies value of the property. example: "#111111" title: Value type: string title: An option for Signup Form Styles type: object title: Options type: array selector: description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background title: Selector type: string title: Collection of Element style for List Signup Forms type: object title: Signup Form element style type: array title: Signup Form type: object required: true responses: "200": content: application/json: schema: description: List signup form. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contents: description: The signup form body content. items: description: Collection of Content for List Signup Forms. properties: section: description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message title: Content Section Name type: string value: description: The content section text. example: Signup message goes here title: Content Section Value type: string title: Collection of Content for List Signup Forms type: object title: Signup form body content type: array header: description: Options for customizing your signup form header. properties: image_align: description: Image alignment. enum: - none - left - center - right example: center title: Image align type: string image_alt: description: Alt text for the image. example: This is an image title: Image Alt type: string image_border_color: description: Image border color. example: "#896d6d" title: Image border color type: string image_border_style: description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid title: Image border style type: string image_border_width: description: Image border width. example: "2" title: Image border width type: string image_height: description: Image height, in pixels. example: "200" title: Image height type: string image_link: description: The URL that the header image will link to. example: gotothisimage.com title: Image Link type: string image_target: description: Image link target. enum: - _blank - "null" example: _blank title: Image target type: string image_url: description: Header image URL. example: http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png title: Header Image URL type: string image_width: description: Image width, in pixels. example: "800" title: Image width type: string text: description: Header text. example: Header Text goes here title: Header Text type: string title: Signup form header options type: object list_id: description: The signup form's list id. example: 4ca5becb8d readOnly: true title: List ID type: string signup_form_url: description: Signup form URL. title: Signup form URL type: string styles: description: An array of objects, each representing an element style for the signup form. items: description: Collection of Element style for List Signup Forms. properties: options: description: A collection of options for a selector. items: description: An option for Signup Form Styles. properties: property: description: A string that identifies the property. example: background-color title: Property type: string value: description: A string that identifies value of the property. example: "#111111" title: Value type: string title: An option for Signup Form Styles type: object title: Options type: array selector: description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background title: Selector type: string title: Collection of Element style for List Signup Forms type: object title: Signup Form element style type: array title: Signup Form type: object application/problem+json: schema: description: List signup form. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array contents: description: The signup form body content. items: description: Collection of Content for List Signup Forms. properties: section: description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message title: Content Section Name type: string value: description: The content section text. example: Signup message goes here title: Content Section Value type: string title: Collection of Content for List Signup Forms type: object title: Signup form body content type: array header: description: Options for customizing your signup form header. properties: image_align: description: Image alignment. enum: - none - left - center - right example: center title: Image align type: string image_alt: description: Alt text for the image. example: This is an image title: Image Alt type: string image_border_color: description: Image border color. example: "#896d6d" title: Image border color type: string image_border_style: description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid title: Image border style type: string image_border_width: description: Image border width. example: "2" title: Image border width type: string image_height: description: Image height, in pixels. example: "200" title: Image height type: string image_link: description: The URL that the header image will link to. example: gotothisimage.com title: Image Link type: string image_target: description: Image link target. enum: - _blank - "null" example: _blank title: Image target type: string image_url: description: Header image URL. example: http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png title: Header Image URL type: string image_width: description: Image width, in pixels. example: "800" title: Image width type: string text: description: Header text. example: Header Text goes here title: Header Text type: string title: Signup form header options type: object list_id: description: The signup form's list id. example: 4ca5becb8d readOnly: true title: List ID type: string signup_form_url: description: Signup form URL. title: Signup form URL type: string styles: description: An array of objects, each representing an element style for the signup form. items: description: Collection of Element style for List Signup Forms. properties: options: description: A collection of options for a selector. items: description: An option for Signup Form Styles. properties: property: description: A string that identifies the property. example: background-color title: Property type: string value: description: A string that identifies value of the property. example: "#111111" title: Value type: string title: An option for Signup Form Styles type: object title: Options type: array selector: description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background title: Selector type: string title: Collection of Element style for List Signup Forms type: object title: Signup Form element style type: array title: Signup Form 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: Customize signup form tags: - lists x-custom-config: methodNameCamel: updateListSignupForm methodNameSnake: update_list_signup_form "/lists/{list_id}/surveys": get: deprecated: false description: Get information about all available surveys for a specific list. operationId: getListsIdSurveys parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID responses: "200": 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 information about all surveys for a list tags: - lists x-custom-config: methodNameCamel: getAllSurveysForList methodNameSnake: get_all_surveys_for_list "/lists/{list_id}/surveys/{survey_id}": get: deprecated: false description: Get details about a specific survey. operationId: getListsIdSurveysId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The ID of the survey. in: path name: survey_id required: true schema: type: string x-title: Survey ID responses: "200": 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 survey tags: - lists x-custom-config: methodNameCamel: getSurvey methodNameSnake: get_survey "/lists/{list_id}/surveys/{survey_id}/actions/create-email": post: deprecated: false description: Utilize the List ID and Survey ID to generate a Campaign that links to your survey. operationId: postListsIdSurveysIdActionsCreateEmail parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The ID of the survey. in: path name: survey_id required: true schema: type: string x-title: Survey 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: Campaign Instance 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: Create a Survey Campaign tags: - Surveys x-custom-config: methodNameCamel: createEmail methodNameSnake: create_email "/lists/{list_id}/surveys/{survey_id}/actions/publish": post: deprecated: false description: Publish a survey that is in draft, unpublished, or has been previously published and edited. operationId: postListsIdSurveysIdActionsPublish parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The ID of the survey. in: path name: survey_id required: true schema: type: string x-title: Survey ID responses: "200": description: Survey Published 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: Publish a Survey tags: - Surveys x-custom-config: methodNameCamel: publishSurvey methodNameSnake: publish_survey "/lists/{list_id}/surveys/{survey_id}/actions/unpublish": post: deprecated: false description: Unpublish a survey that has been published. operationId: postListsIdSurveysIdActionsUnpublish parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The ID of the survey. in: path name: survey_id required: true schema: type: string x-title: Survey ID responses: "200": description: Survey Instance 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: Unpublish a Survey tags: - Surveys x-custom-config: methodNameCamel: unpublishSurvey methodNameSnake: unpublish_survey "/lists/{list_id}/tag-search": get: deprecated: false description: Search for tags on a list by name. If no name is provided, will return all tags on the list. operationId: searchTagsByName parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned. in: query name: name required: false schema: type: string x-title: Name responses: "200": content: application/json: schema: description: A list of tags matching the input query. properties: tags: description: A list of matching tags. items: properties: id: description: The unique id for the tag. readOnly: true title: Tag ID type: integer name: description: The name of the tag. title: Tag Name type: string readOnly: true title: Tags type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Tag search results type: object application/problem+json: schema: description: A list of tags matching the input query. properties: tags: description: A list of matching tags. items: properties: id: description: The unique id for the tag. readOnly: true title: Tag ID type: integer name: description: The name of the tag. title: Tag Name type: string readOnly: true title: Tags type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Tag search results 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: Search for tags on a list by name. tags: - lists x-custom-config: methodNameCamel: tagSearch methodNameSnake: tag_search "/lists/{list_id}/webhooks": get: deprecated: false description: Get information about all webhooks for a specific list. operationId: getListsIdWebhooks parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID responses: "200": content: application/json: schema: description: Manage webhooks for a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. title: List ID type: string 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 specific list member. items: description: Webhook configured for the given list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean readOnly: true title: Events type: object id: description: An string that uniquely identifies this webhook. example: 5d9a5e3f7b readOnly: true title: Unique ID type: string list_id: description: The unique id for the list. example: 4ca5becb8d readOnly: true title: List ID type: string sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean readOnly: true title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: true title: URL type: string title: List Webhooks type: object title: Webhooks type: array title: List Webhooks type: object application/problem+json: schema: description: Manage webhooks for a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array list_id: description: The list id. title: List ID type: string 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 specific list member. items: description: Webhook configured for the given list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean readOnly: true title: Events type: object id: description: An string that uniquely identifies this webhook. example: 5d9a5e3f7b readOnly: true title: Unique ID type: string list_id: description: The unique id for the list. example: 4ca5becb8d readOnly: true title: List ID type: string sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean readOnly: true title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: true title: URL type: string title: List Webhooks type: object title: Webhooks type: array title: List 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 webhooks tags: - lists x-custom-config: methodNameCamel: getListWebhooks methodNameSnake: get_list_webhooks post: deprecated: false description: Create a new webhook for a specific list. operationId: postListsIdWebhooks parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID requestBody: $ref: "#/components/requestBodies/postListsIdWebhooksBody" responses: "200": content: application/json: schema: description: Webhook configured for the given list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean readOnly: true title: Events type: object id: description: An string that uniquely identifies this webhook. example: 5d9a5e3f7b readOnly: true title: Unique ID type: string list_id: description: The unique id for the list. example: 4ca5becb8d readOnly: true title: List ID type: string sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean readOnly: true title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: true title: URL type: string title: List Webhooks type: object application/problem+json: schema: description: Webhook configured for the given list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean readOnly: true title: Events type: object id: description: An string that uniquely identifies this webhook. example: 5d9a5e3f7b readOnly: true title: Unique ID type: string list_id: description: The unique id for the list. example: 4ca5becb8d readOnly: true title: List ID type: string sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean readOnly: true title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: true title: URL type: string title: List 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: Add webhook tags: - lists x-custom-config: methodNameCamel: createListWebhook methodNameSnake: create_list_webhook "/lists/{list_id}/webhooks/{webhook_id}": delete: deprecated: false description: Delete a specific webhook in a list. operationId: deleteListsIdWebhooksId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The webhook's id. in: path name: 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 webhook tags: - lists x-custom-config: methodNameCamel: deleteListWebhook methodNameSnake: delete_list_webhook get: deprecated: false description: Get information about a specific webhook. operationId: getListsIdWebhooksId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The webhook's id. in: path name: webhook_id required: true schema: type: string responses: "200": content: application/json: schema: description: Webhook configured for the given list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean readOnly: true title: Events type: object id: description: An string that uniquely identifies this webhook. example: 5d9a5e3f7b readOnly: true title: Unique ID type: string list_id: description: The unique id for the list. example: 4ca5becb8d readOnly: true title: List ID type: string sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean readOnly: true title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: true title: URL type: string title: List Webhooks type: object application/problem+json: schema: description: Webhook configured for the given list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean readOnly: true title: Events type: object id: description: An string that uniquely identifies this webhook. example: 5d9a5e3f7b readOnly: true title: Unique ID type: string list_id: description: The unique id for the list. example: 4ca5becb8d readOnly: true title: List ID type: string sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean readOnly: true title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: true title: URL type: string title: List 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: Get webhook info tags: - lists x-custom-config: methodNameCamel: getListWebhook methodNameSnake: get_list_webhook patch: deprecated: false description: Update the settings for an existing webhook. operationId: patchListsIdWebhooksId parameters: - description: The unique ID for the list. in: path name: list_id required: true schema: type: string x-title: List ID - description: The webhook's id. in: path name: webhook_id required: true schema: type: string requestBody: $ref: "#/components/requestBodies/postListsIdWebhooksBody" responses: "200": content: application/json: schema: description: Webhook configured for the given list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean readOnly: true title: Events type: object id: description: An string that uniquely identifies this webhook. example: 5d9a5e3f7b readOnly: true title: Unique ID type: string list_id: description: The unique id for the list. example: 4ca5becb8d readOnly: true title: List ID type: string sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean readOnly: true title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: true title: URL type: string title: List Webhooks type: object application/problem+json: schema: description: Webhook configured for the given list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean readOnly: true title: Events type: object id: description: An string that uniquely identifies this webhook. example: 5d9a5e3f7b readOnly: true title: Unique ID type: string list_id: description: The unique id for the list. example: 4ca5becb8d readOnly: true title: List ID type: string sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean readOnly: true title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook readOnly: true title: URL type: string title: List 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: Update webhook tags: - lists x-custom-config: methodNameCamel: updateListWebhook methodNameSnake: update_list_webhook /ping: get: deprecated: false description: A health check for the API that won't return any account-specific information. operationId: getPing responses: "200": content: application/json: schema: description: API health status. properties: health_status: description: This will return a constant string value if the request is successful. Ex. "Everything's Chimpy!" example: "\"Everything's Chimpy!\"" readOnly: true title: API health status type: string title: API health status type: object application/problem+json: schema: description: API health status. properties: health_status: description: This will return a constant string value if the request is successful. Ex. "Everything's Chimpy!" example: "\"Everything's Chimpy!\"" readOnly: true title: API health status type: string title: API health status 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: Ping tags: - ping x-custom-config: methodNameCamel: get methodNameSnake: get /reporting/facebook-ads: get: description: Get reports of Facebook ads. operationId: getReportingFacebookAds 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: A collection 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 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 title: Recipients type: object report_summary: description: High level reporting stats for an outreach. properties: click_rate: type: number clicks: type: integer conversion_rate: type: number ecommerce: properties: average_order_revenue: type: number currency_code: type: string total_revenue: type: number type: object engagements: type: integer impressions: type: number open_rate: type: number opens: type: integer reach: type: integer subscriber_clicks: type: integer subscribes: type: integer total_sent: type: integer unique_opens: type: integer unique_visits: type: integer visits: type: integer title: Report Summary type: object show_report: description: "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." title: Show Report type: boolean start_time: description: The date and time the outreach was started in ISO 8601 format. format: date-time title: Start Time type: string status: description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished title: Outreach Status type: string thumbnail: description: The URL of the thumbnail for this outreach. title: Thumbnail type: string type: description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey title: Outreach Type type: string updated_at: description: The date and time the outreach was last updated in ISO 8601 format. format: date-time title: Updated At type: string web_id: description: The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. title: Web ID type: integer type: object - properties: email_source_name: title: "Ad: Email Source Name" type: string end_time: description: The date and time the ad was ended in ISO 8601 format. format: date-time title: "Ad: End Time" type: string needs_attention: description: If the ad has a problem and needs attention. title: "Ad: Needs Attention" type: boolean paused_at: description: The date and time the ad was paused in ISO 8601 format. format: date-time title: "Ad: Paused At" type: string was_canceled_by_facebook: title: "Ad: Was Canceled By Facebook" type: boolean type: object - properties: audience: description: Audience settings properties: email_source: properties: is_segment: description: Is the source reference a segment type: boolean list_name: description: Associated list name to the source type: string name: description: Email source name type: string segment_type: description: Segment type if this source is tied to a segment type: string type: description: Type of the email source type: string type: object include_source_in_target: description: To include list contacts as part of audience type: boolean lookalike_country_code: description: To find similar audience in given country type: string source_type: description: List or Facebook based audience enum: - facebook - list type: string targeting_specs: properties: gender: enum: - 0 - 1 - 2 type: integer interests: items: properties: name: type: string type: object type: array locations: properties: cities: items: type: string type: array countries: items: type: string type: array regions: items: type: string type: array zips: items: type: string type: array type: object max_age: type: integer min_age: type: integer type: object type: description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience type: string type: object audience_activity: properties: clicks: items: properties: clicks: type: integer date: type: string type: object type: array impressions: items: properties: date: type: string impressions: type: integer type: object type: array revenue: items: properties: date: type: string revenue: type: number type: object type: array type: object budget: properties: currency_code: description: Currency code example: USD type: string duration: description: Duration of the ad in seconds example: 86400 type: integer total_amount: description: Total budget of the ad example: 500 type: number type: object channel: description: Channel settings properties: fb_placement_audience: description: Is this for facebook audience example: false type: boolean fb_placement_feed: description: Is this for facebook feed example: true type: boolean ig_placement_feed: description: Is this for instagram feed example: false type: boolean type: object report_summary: description: Report summary of facebook ad properties: average_daily_budget: properties: amount: type: number currency_code: type: string type: object average_order_amount: properties: amount: type: number currency_code: type: string type: object click_rate: type: number clicks: type: integer comments: type: integer cost_per_click: properties: amount: type: number currency_code: type: string type: object ecommerce: properties: currency_code: type: string total_revenue: type: number type: object extended_at: properties: datetime: type: string timezone: type: string type: object first_time_buyers: type: integer has_extended_ad_duration: type: boolean impressions: type: integer likes: type: integer reach: type: integer return_on_investment: type: number shares: type: integer total_orders: type: integer total_products_sold: type: integer unique_clicks: type: integer type: object type: object - properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array type: object 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: A collection 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 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 title: Recipients type: object report_summary: description: High level reporting stats for an outreach. properties: click_rate: type: number clicks: type: integer conversion_rate: type: number ecommerce: properties: average_order_revenue: type: number currency_code: type: string total_revenue: type: number type: object engagements: type: integer impressions: type: number open_rate: type: number opens: type: integer reach: type: integer subscriber_clicks: type: integer subscribes: type: integer total_sent: type: integer unique_opens: type: integer unique_visits: type: integer visits: type: integer title: Report Summary type: object show_report: description: "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." title: Show Report type: boolean start_time: description: The date and time the outreach was started in ISO 8601 format. format: date-time title: Start Time type: string status: description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished title: Outreach Status type: string thumbnail: description: The URL of the thumbnail for this outreach. title: Thumbnail type: string type: description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey title: Outreach Type type: string updated_at: description: The date and time the outreach was last updated in ISO 8601 format. format: date-time title: Updated At type: string web_id: description: The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. title: Web ID type: integer type: object - properties: email_source_name: title: "Ad: Email Source Name" type: string end_time: description: The date and time the ad was ended in ISO 8601 format. format: date-time title: "Ad: End Time" type: string needs_attention: description: If the ad has a problem and needs attention. title: "Ad: Needs Attention" type: boolean paused_at: description: The date and time the ad was paused in ISO 8601 format. format: date-time title: "Ad: Paused At" type: string was_canceled_by_facebook: title: "Ad: Was Canceled By Facebook" type: boolean type: object - properties: audience: description: Audience settings properties: email_source: properties: is_segment: description: Is the source reference a segment type: boolean list_name: description: Associated list name to the source type: string name: description: Email source name type: string segment_type: description: Segment type if this source is tied to a segment type: string type: description: Type of the email source type: string type: object include_source_in_target: description: To include list contacts as part of audience type: boolean lookalike_country_code: description: To find similar audience in given country type: string source_type: description: List or Facebook based audience enum: - facebook - list type: string targeting_specs: properties: gender: enum: - 0 - 1 - 2 type: integer interests: items: properties: name: type: string type: object type: array locations: properties: cities: items: type: string type: array countries: items: type: string type: array regions: items: type: string type: array zips: items: type: string type: array type: object max_age: type: integer min_age: type: integer type: object type: description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience type: string type: object audience_activity: properties: clicks: items: properties: clicks: type: integer date: type: string type: object type: array impressions: items: properties: date: type: string impressions: type: integer type: object type: array revenue: items: properties: date: type: string revenue: type: number type: object type: array type: object budget: properties: currency_code: description: Currency code example: USD type: string duration: description: Duration of the ad in seconds example: 86400 type: integer total_amount: description: Total budget of the ad example: 500 type: number type: object channel: description: Channel settings properties: fb_placement_audience: description: Is this for facebook audience example: false type: boolean fb_placement_feed: description: Is this for facebook feed example: true type: boolean ig_placement_feed: description: Is this for instagram feed example: false type: boolean type: object report_summary: description: Report summary of facebook ad properties: average_daily_budget: properties: amount: type: number currency_code: type: string type: object average_order_amount: properties: amount: type: number currency_code: type: string type: object click_rate: type: number clicks: type: integer comments: type: integer cost_per_click: properties: amount: type: number currency_code: type: string type: object ecommerce: properties: currency_code: type: string total_revenue: type: number type: object extended_at: properties: datetime: type: string timezone: type: string type: object first_time_buyers: type: integer has_extended_ad_duration: type: boolean impressions: type: integer likes: type: integer reach: type: integer return_on_investment: type: number shares: type: integer total_orders: type: integer total_products_sold: type: integer unique_clicks: type: integer type: object type: object - properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array type: object 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: List of Facebook Ad Report Instances 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 facebook ads reports tags: - reporting x-custom-config: methodNameCamel: getFacebookAdsReportAll methodNameSnake: get_facebook_ads_report_all "/reporting/facebook-ads/{outreach_id}": get: description: Get report of a Facebook ad. operationId: getReportingFacebookAdsId 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: The outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID - 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: 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 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 title: Recipients type: object report_summary: description: High level reporting stats for an outreach. properties: click_rate: type: number clicks: type: integer conversion_rate: type: number ecommerce: properties: average_order_revenue: type: number currency_code: type: string total_revenue: type: number type: object engagements: type: integer impressions: type: number open_rate: type: number opens: type: integer reach: type: integer subscriber_clicks: type: integer subscribes: type: integer total_sent: type: integer unique_opens: type: integer unique_visits: type: integer visits: type: integer title: Report Summary type: object show_report: description: "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." title: Show Report type: boolean start_time: description: The date and time the outreach was started in ISO 8601 format. format: date-time title: Start Time type: string status: description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished title: Outreach Status type: string thumbnail: description: The URL of the thumbnail for this outreach. title: Thumbnail type: string type: description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey title: Outreach Type type: string updated_at: description: The date and time the outreach was last updated in ISO 8601 format. format: date-time title: Updated At type: string web_id: description: The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. title: Web ID type: integer type: object - properties: email_source_name: title: "Ad: Email Source Name" type: string end_time: description: The date and time the ad was ended in ISO 8601 format. format: date-time title: "Ad: End Time" type: string needs_attention: description: If the ad has a problem and needs attention. title: "Ad: Needs Attention" type: boolean paused_at: description: The date and time the ad was paused in ISO 8601 format. format: date-time title: "Ad: Paused At" type: string was_canceled_by_facebook: title: "Ad: Was Canceled By Facebook" type: boolean type: object - properties: audience: description: Audience settings properties: email_source: properties: is_segment: description: Is the source reference a segment type: boolean list_name: description: Associated list name to the source type: string name: description: Email source name type: string segment_type: description: Segment type if this source is tied to a segment type: string type: description: Type of the email source type: string type: object include_source_in_target: description: To include list contacts as part of audience type: boolean lookalike_country_code: description: To find similar audience in given country type: string source_type: description: List or Facebook based audience enum: - facebook - list type: string targeting_specs: properties: gender: enum: - 0 - 1 - 2 type: integer interests: items: properties: name: type: string type: object type: array locations: properties: cities: items: type: string type: array countries: items: type: string type: array regions: items: type: string type: array zips: items: type: string type: array type: object max_age: type: integer min_age: type: integer type: object type: description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience type: string type: object audience_activity: properties: clicks: items: properties: clicks: type: integer date: type: string type: object type: array impressions: items: properties: date: type: string impressions: type: integer type: object type: array revenue: items: properties: date: type: string revenue: type: number type: object type: array type: object budget: properties: currency_code: description: Currency code example: USD type: string duration: description: Duration of the ad in seconds example: 86400 type: integer total_amount: description: Total budget of the ad example: 500 type: number type: object channel: description: Channel settings properties: fb_placement_audience: description: Is this for facebook audience example: false type: boolean fb_placement_feed: description: Is this for facebook feed example: true type: boolean ig_placement_feed: description: Is this for instagram feed example: false type: boolean type: object report_summary: description: Report summary of facebook ad properties: average_daily_budget: properties: amount: type: number currency_code: type: string type: object average_order_amount: properties: amount: type: number currency_code: type: string type: object click_rate: type: number clicks: type: integer comments: type: integer cost_per_click: properties: amount: type: number currency_code: type: string type: object ecommerce: properties: currency_code: type: string total_revenue: type: number type: object extended_at: properties: datetime: type: string timezone: type: string type: object first_time_buyers: type: integer has_extended_ad_duration: type: boolean impressions: type: integer likes: type: integer reach: type: integer return_on_investment: type: number shares: type: integer total_orders: type: integer total_products_sold: type: integer unique_clicks: type: integer type: object type: object - properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array type: object application/problem+json: schema: 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 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 title: Recipients type: object report_summary: description: High level reporting stats for an outreach. properties: click_rate: type: number clicks: type: integer conversion_rate: type: number ecommerce: properties: average_order_revenue: type: number currency_code: type: string total_revenue: type: number type: object engagements: type: integer impressions: type: number open_rate: type: number opens: type: integer reach: type: integer subscriber_clicks: type: integer subscribes: type: integer total_sent: type: integer unique_opens: type: integer unique_visits: type: integer visits: type: integer title: Report Summary type: object show_report: description: "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context." title: Show Report type: boolean start_time: description: The date and time the outreach was started in ISO 8601 format. format: date-time title: Start Time type: string status: description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished title: Outreach Status type: string thumbnail: description: The URL of the thumbnail for this outreach. title: Thumbnail type: string type: description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey title: Outreach Type type: string updated_at: description: The date and time the outreach was last updated in ISO 8601 format. format: date-time title: Updated At type: string web_id: description: The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. title: Web ID type: integer type: object - properties: email_source_name: title: "Ad: Email Source Name" type: string end_time: description: The date and time the ad was ended in ISO 8601 format. format: date-time title: "Ad: End Time" type: string needs_attention: description: If the ad has a problem and needs attention. title: "Ad: Needs Attention" type: boolean paused_at: description: The date and time the ad was paused in ISO 8601 format. format: date-time title: "Ad: Paused At" type: string was_canceled_by_facebook: title: "Ad: Was Canceled By Facebook" type: boolean type: object - properties: audience: description: Audience settings properties: email_source: properties: is_segment: description: Is the source reference a segment type: boolean list_name: description: Associated list name to the source type: string name: description: Email source name type: string segment_type: description: Segment type if this source is tied to a segment type: string type: description: Type of the email source type: string type: object include_source_in_target: description: To include list contacts as part of audience type: boolean lookalike_country_code: description: To find similar audience in given country type: string source_type: description: List or Facebook based audience enum: - facebook - list type: string targeting_specs: properties: gender: enum: - 0 - 1 - 2 type: integer interests: items: properties: name: type: string type: object type: array locations: properties: cities: items: type: string type: array countries: items: type: string type: array regions: items: type: string type: array zips: items: type: string type: array type: object max_age: type: integer min_age: type: integer type: object type: description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience type: string type: object audience_activity: properties: clicks: items: properties: clicks: type: integer date: type: string type: object type: array impressions: items: properties: date: type: string impressions: type: integer type: object type: array revenue: items: properties: date: type: string revenue: type: number type: object type: array type: object budget: properties: currency_code: description: Currency code example: USD type: string duration: description: Duration of the ad in seconds example: 86400 type: integer total_amount: description: Total budget of the ad example: 500 type: number type: object channel: description: Channel settings properties: fb_placement_audience: description: Is this for facebook audience example: false type: boolean fb_placement_feed: description: Is this for facebook feed example: true type: boolean ig_placement_feed: description: Is this for instagram feed example: false type: boolean type: object report_summary: description: Report summary of facebook ad properties: average_daily_budget: properties: amount: type: number currency_code: type: string type: object average_order_amount: properties: amount: type: number currency_code: type: string type: object click_rate: type: number clicks: type: integer comments: type: integer cost_per_click: properties: amount: type: number currency_code: type: string type: object ecommerce: properties: currency_code: type: string total_revenue: type: number type: object extended_at: properties: datetime: type: string timezone: type: string type: object first_time_buyers: type: integer has_extended_ad_duration: type: boolean impressions: type: integer likes: type: integer reach: type: integer return_on_investment: type: number shares: type: integer total_orders: type: integer total_products_sold: type: integer unique_clicks: type: integer type: object type: object - properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array type: object description: Facebook Ad report Instance 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 facebook ad report tags: - reporting x-custom-config: methodNameCamel: getFacebookAdReport methodNameSnake: get_facebook_ad_report "/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity": get: description: Get breakdown of product activity for an outreach. operationId: getReportingFacebookAdsIdEcommerceProductActivity 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 outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - title - total_revenue - total_purchased type: string x-title: Sort By Field responses: "200": content: application/json: schema: description: A collection of ecommerce 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: items: properties: currency_code: type: string image_url: type: string recommendation_purchased: type: integer recommendation_total: type: integer sku: type: string title: type: string total_purchased: type: number total_revenue: type: number type: object 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: A collection of ecommerce 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: items: properties: currency_code: type: string image_url: type: string recommendation_purchased: type: integer recommendation_total: type: integer sku: type: string title: type: string total_purchased: type: number total_revenue: type: number type: object 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: Ecommerce Product Activity Instance 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 facebook ecommerce report tags: - reporting x-custom-config: methodNameCamel: getFacebookAdProductActivityReport methodNameSnake: get_facebook_ad_product_activity_report /reporting/landing-pages: get: description: Get reports of landing pages. operationId: getReportingLandingPages 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 landing pages. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array landing_pages: items: description: A summary of an individual landing page'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 clicks: description: The number of clicks to this landing pages. readOnly: true title: Clicks type: integer conversion_rate: description: The percentage of people who visited your landing page and were added to your list. readOnly: true title: Conversion rate type: number ecommerce: properties: average_order_revenue: description: The average order revenue of this landing page. readOnly: true title: Average Order Revenue type: number currency_code: description: The user's currency code. readOnly: true title: Currency code type: string total_orders: description: The total number of orders associated with this landing page. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue of this landing page. readOnly: true title: Total Revenue type: number type: object id: description: A string that uniquely identifies this landing page. example: 00dfc2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list id connected to this landing page. readOnly: true title: List Id type: string list_name: description: List Name example: Test List readOnly: true title: List Name type: string name: description: The name of this landing page the user will see. readOnly: true title: Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published At type: string signup_tags: description: A list of tags associated to the landing page. items: properties: tag_id: description: The unique id for the tag. readOnly: true title: Tag ID type: integer tag_name: description: The name of the tag. readOnly: true title: Tag Name type: string title: Tag type: object readOnly: true title: Signup Tags type: array status: description: The status of the landing page. readOnly: true title: Status type: string subscribes: description: The number of subscribes to this landing pages. readOnly: true title: Subscribes type: integer timeseries: properties: daily_stats: description: The clicks and visits data from the last seven days. properties: clicks: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 13 readOnly: true title: Value type: integer type: object title: Clicks type: array unique_visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 1 readOnly: true title: Value type: integer type: object title: Unique Visits type: array visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 11 readOnly: true title: Value type: integer type: object title: Visits type: array readOnly: true title: Daily clicks and visits data type: object weekly_stats: description: The clicks and visits data from the last five weeks. properties: clicks: description: The total number of clicks in a week. items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 23 readOnly: true title: Value type: integer type: object title: Clicks type: array unique_visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 1 readOnly: true title: Value type: integer type: object title: Unique Visits type: array visits: description: The total number of visits in a week. items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 49 readOnly: true title: Value type: integer type: object title: Visits type: array readOnly: true title: Weekly clicks and visits data type: object type: object title: description: The name of the landing page the user's customers will see. readOnly: true title: Title type: string unique_visits: description: The number of unique visits to this landing pages. readOnly: true title: Unique Visits type: integer unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished At type: string url: description: The landing page url. readOnly: true title: Url type: string visits: description: The number of visits to this landing pages. readOnly: true title: Visits type: integer web_id: description: The ID used in the Mailchimp web application. example: 33345484 readOnly: true title: Landing Page Web ID type: integer title: Landing Page Report type: object 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: A collection of landing pages. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array landing_pages: items: description: A summary of an individual landing page'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 clicks: description: The number of clicks to this landing pages. readOnly: true title: Clicks type: integer conversion_rate: description: The percentage of people who visited your landing page and were added to your list. readOnly: true title: Conversion rate type: number ecommerce: properties: average_order_revenue: description: The average order revenue of this landing page. readOnly: true title: Average Order Revenue type: number currency_code: description: The user's currency code. readOnly: true title: Currency code type: string total_orders: description: The total number of orders associated with this landing page. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue of this landing page. readOnly: true title: Total Revenue type: number type: object id: description: A string that uniquely identifies this landing page. example: 00dfc2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list id connected to this landing page. readOnly: true title: List Id type: string list_name: description: List Name example: Test List readOnly: true title: List Name type: string name: description: The name of this landing page the user will see. readOnly: true title: Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published At type: string signup_tags: description: A list of tags associated to the landing page. items: properties: tag_id: description: The unique id for the tag. readOnly: true title: Tag ID type: integer tag_name: description: The name of the tag. readOnly: true title: Tag Name type: string title: Tag type: object readOnly: true title: Signup Tags type: array status: description: The status of the landing page. readOnly: true title: Status type: string subscribes: description: The number of subscribes to this landing pages. readOnly: true title: Subscribes type: integer timeseries: properties: daily_stats: description: The clicks and visits data from the last seven days. properties: clicks: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 13 readOnly: true title: Value type: integer type: object title: Clicks type: array unique_visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 1 readOnly: true title: Value type: integer type: object title: Unique Visits type: array visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 11 readOnly: true title: Value type: integer type: object title: Visits type: array readOnly: true title: Daily clicks and visits data type: object weekly_stats: description: The clicks and visits data from the last five weeks. properties: clicks: description: The total number of clicks in a week. items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 23 readOnly: true title: Value type: integer type: object title: Clicks type: array unique_visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 1 readOnly: true title: Value type: integer type: object title: Unique Visits type: array visits: description: The total number of visits in a week. items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 49 readOnly: true title: Value type: integer type: object title: Visits type: array readOnly: true title: Weekly clicks and visits data type: object type: object title: description: The name of the landing page the user's customers will see. readOnly: true title: Title type: string unique_visits: description: The number of unique visits to this landing pages. readOnly: true title: Unique Visits type: integer unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished At type: string url: description: The landing page url. readOnly: true title: Url type: string visits: description: The number of visits to this landing pages. readOnly: true title: Visits type: integer web_id: description: The ID used in the Mailchimp web application. example: 33345484 readOnly: true title: Landing Page Web ID type: integer title: Landing Page Report type: object 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: List of Landing Page Report Instances 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 landing pages reports tags: - reporting x-custom-config: methodNameCamel: getLandingPageReportsAll methodNameSnake: get_landing_page_reports_all "/reporting/landing-pages/{outreach_id}": get: description: Get report of a landing page. operationId: getReportingLandingPagesId 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: The outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID - 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: A summary of an individual landing page'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 clicks: description: The number of clicks to this landing pages. readOnly: true title: Clicks type: integer conversion_rate: description: The percentage of people who visited your landing page and were added to your list. readOnly: true title: Conversion rate type: number ecommerce: properties: average_order_revenue: description: The average order revenue of this landing page. readOnly: true title: Average Order Revenue type: number currency_code: description: The user's currency code. readOnly: true title: Currency code type: string total_orders: description: The total number of orders associated with this landing page. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue of this landing page. readOnly: true title: Total Revenue type: number type: object id: description: A string that uniquely identifies this landing page. example: 00dfc2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list id connected to this landing page. readOnly: true title: List Id type: string list_name: description: List Name example: Test List readOnly: true title: List Name type: string name: description: The name of this landing page the user will see. readOnly: true title: Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published At type: string signup_tags: description: A list of tags associated to the landing page. items: properties: tag_id: description: The unique id for the tag. readOnly: true title: Tag ID type: integer tag_name: description: The name of the tag. readOnly: true title: Tag Name type: string title: Tag type: object readOnly: true title: Signup Tags type: array status: description: The status of the landing page. readOnly: true title: Status type: string subscribes: description: The number of subscribes to this landing pages. readOnly: true title: Subscribes type: integer timeseries: properties: daily_stats: description: The clicks and visits data from the last seven days. properties: clicks: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 13 readOnly: true title: Value type: integer type: object title: Clicks type: array unique_visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 1 readOnly: true title: Value type: integer type: object title: Unique Visits type: array visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 11 readOnly: true title: Value type: integer type: object title: Visits type: array readOnly: true title: Daily clicks and visits data type: object weekly_stats: description: The clicks and visits data from the last five weeks. properties: clicks: description: The total number of clicks in a week. items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 23 readOnly: true title: Value type: integer type: object title: Clicks type: array unique_visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 1 readOnly: true title: Value type: integer type: object title: Unique Visits type: array visits: description: The total number of visits in a week. items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 49 readOnly: true title: Value type: integer type: object title: Visits type: array readOnly: true title: Weekly clicks and visits data type: object type: object title: description: The name of the landing page the user's customers will see. readOnly: true title: Title type: string unique_visits: description: The number of unique visits to this landing pages. readOnly: true title: Unique Visits type: integer unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished At type: string url: description: The landing page url. readOnly: true title: Url type: string visits: description: The number of visits to this landing pages. readOnly: true title: Visits type: integer web_id: description: The ID used in the Mailchimp web application. example: 33345484 readOnly: true title: Landing Page Web ID type: integer title: Landing Page Report type: object application/problem+json: schema: description: A summary of an individual landing page'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 clicks: description: The number of clicks to this landing pages. readOnly: true title: Clicks type: integer conversion_rate: description: The percentage of people who visited your landing page and were added to your list. readOnly: true title: Conversion rate type: number ecommerce: properties: average_order_revenue: description: The average order revenue of this landing page. readOnly: true title: Average Order Revenue type: number currency_code: description: The user's currency code. readOnly: true title: Currency code type: string total_orders: description: The total number of orders associated with this landing page. readOnly: true title: Total Orders type: integer total_revenue: description: The total revenue of this landing page. readOnly: true title: Total Revenue type: number type: object id: description: A string that uniquely identifies this landing page. example: 00dfc2e1f0 readOnly: true title: Landing Page ID type: string list_id: description: The list id connected to this landing page. readOnly: true title: List Id type: string list_name: description: List Name example: Test List readOnly: true title: List Name type: string name: description: The name of this landing page the user will see. readOnly: true title: Name type: string published_at: description: The time this landing page was published. format: date-time readOnly: true title: Published At type: string signup_tags: description: A list of tags associated to the landing page. items: properties: tag_id: description: The unique id for the tag. readOnly: true title: Tag ID type: integer tag_name: description: The name of the tag. readOnly: true title: Tag Name type: string title: Tag type: object readOnly: true title: Signup Tags type: array status: description: The status of the landing page. readOnly: true title: Status type: string subscribes: description: The number of subscribes to this landing pages. readOnly: true title: Subscribes type: integer timeseries: properties: daily_stats: description: The clicks and visits data from the last seven days. properties: clicks: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 13 readOnly: true title: Value type: integer type: object title: Clicks type: array unique_visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 1 readOnly: true title: Value type: integer type: object title: Unique Visits type: array visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 11 readOnly: true title: Value type: integer type: object title: Visits type: array readOnly: true title: Daily clicks and visits data type: object weekly_stats: description: The clicks and visits data from the last five weeks. properties: clicks: description: The total number of clicks in a week. items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 23 readOnly: true title: Value type: integer type: object title: Clicks type: array unique_visits: items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 1 readOnly: true title: Value type: integer type: object title: Unique Visits type: array visits: description: The total number of visits in a week. items: properties: date: example: 2018-04-25 readOnly: true title: Date type: string val: example: 49 readOnly: true title: Value type: integer type: object title: Visits type: array readOnly: true title: Weekly clicks and visits data type: object type: object title: description: The name of the landing page the user's customers will see. readOnly: true title: Title type: string unique_visits: description: The number of unique visits to this landing pages. readOnly: true title: Unique Visits type: integer unpublished_at: description: The time this landing page was unpublished. format: date-time readOnly: true title: Unpublished At type: string url: description: The landing page url. readOnly: true title: Url type: string visits: description: The number of visits to this landing pages. readOnly: true title: Visits type: integer web_id: description: The ID used in the Mailchimp web application. example: 33345484 readOnly: true title: Landing Page Web ID type: integer title: Landing Page Report type: object description: Landing Page Report Instance 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 landing page report tags: - reporting x-custom-config: methodNameCamel: getLandingPageReport methodNameSnake: get_landing_page_report /reporting/surveys: get: description: Get reports for surveys. operationId: getReportingSurveys 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: properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array surveys: description: The surveys that have reports available. items: description: The report for a survey. properties: created_at: description: The date and time the survey was created in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Created At type: string id: description: A string that uniquely identifies this survey. example: 040d2c2e1f0 readOnly: true title: Survey ID type: string list_id: description: The ID of the list connected to this survey. readOnly: true title: List ID type: string list_name: description: The name of the list connected to this survey. readOnly: true title: List Name type: string published_at: description: The date and time the survey was published in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Published At type: string status: description: The survey's status. enum: - published - unpublished example: published readOnly: true title: Status type: string title: description: The title of the survey. example: New product ideas readOnly: true title: Title type: string total_responses: description: The total number of responses to this survey. example: 810 readOnly: true title: Total Responses type: integer updated_at: description: The date and time the survey was last updated in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Updated At type: string url: description: The URL for the survey. readOnly: true title: URL type: string web_id: description: The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`. example: 165 readOnly: true title: Survey Web ID type: integer title: Survey Report type: object title: Surveys 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: properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array surveys: description: The surveys that have reports available. items: description: The report for a survey. properties: created_at: description: The date and time the survey was created in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Created At type: string id: description: A string that uniquely identifies this survey. example: 040d2c2e1f0 readOnly: true title: Survey ID type: string list_id: description: The ID of the list connected to this survey. readOnly: true title: List ID type: string list_name: description: The name of the list connected to this survey. readOnly: true title: List Name type: string published_at: description: The date and time the survey was published in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Published At type: string status: description: The survey's status. enum: - published - unpublished example: published readOnly: true title: Status type: string title: description: The title of the survey. example: New product ideas readOnly: true title: Title type: string total_responses: description: The total number of responses to this survey. example: 810 readOnly: true title: Total Responses type: integer updated_at: description: The date and time the survey was last updated in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Updated At type: string url: description: The URL for the survey. readOnly: true title: URL type: string web_id: description: The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`. example: 165 readOnly: true title: Survey Web ID type: integer title: Survey Report type: object title: Surveys 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: List of Survey Report Instances 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 survey reports tags: - reporting x-custom-config: methodNameCamel: getSurveyReportsAll methodNameSnake: get_survey_reports_all "/reporting/surveys/{outreach_id}": get: description: Get report for a survey. operationId: getReportingSurveysId 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 outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID responses: "200": content: application/json: schema: description: The report for a survey. properties: created_at: description: The date and time the survey was created in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Created At type: string id: description: A string that uniquely identifies this survey. example: 040d2c2e1f0 readOnly: true title: Survey ID type: string list_id: description: The ID of the list connected to this survey. readOnly: true title: List ID type: string list_name: description: The name of the list connected to this survey. readOnly: true title: List Name type: string published_at: description: The date and time the survey was published in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Published At type: string status: description: The survey's status. enum: - published - unpublished example: published readOnly: true title: Status type: string title: description: The title of the survey. example: New product ideas readOnly: true title: Title type: string total_responses: description: The total number of responses to this survey. example: 810 readOnly: true title: Total Responses type: integer updated_at: description: The date and time the survey was last updated in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Updated At type: string url: description: The URL for the survey. readOnly: true title: URL type: string web_id: description: The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`. example: 165 readOnly: true title: Survey Web ID type: integer title: Survey Report type: object application/problem+json: schema: description: The report for a survey. properties: created_at: description: The date and time the survey was created in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Created At type: string id: description: A string that uniquely identifies this survey. example: 040d2c2e1f0 readOnly: true title: Survey ID type: string list_id: description: The ID of the list connected to this survey. readOnly: true title: List ID type: string list_name: description: The name of the list connected to this survey. readOnly: true title: List Name type: string published_at: description: The date and time the survey was published in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Published At type: string status: description: The survey's status. enum: - published - unpublished example: published readOnly: true title: Status type: string title: description: The title of the survey. example: New product ideas readOnly: true title: Title type: string total_responses: description: The total number of responses to this survey. example: 810 readOnly: true title: Total Responses type: integer updated_at: description: The date and time the survey was last updated in ISO 8601 format. example: 2017-08-04T11:09:01+00:00 format: date-time readOnly: true title: Updated At type: string url: description: The URL for the survey. readOnly: true title: URL type: string web_id: description: The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`. example: 165 readOnly: true title: Survey Web ID type: integer title: Survey Report type: object description: Survey Report Instance 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 survey report tags: - reporting x-custom-config: methodNameCamel: getSurveyReport methodNameSnake: get_survey_report "/reporting/surveys/{outreach_id}/questions": get: description: Get reports for survey questions. operationId: getReportingSurveysIdQuestions 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 outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID responses: "200": content: application/json: schema: properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array questions: description: An array of reports for each question on the survey. items: description: The details of a survey question's report. properties: average_rating: description: The average rating for this range question. example: 2.5 format: float readOnly: true title: Average Rating for a Range Question type: number contact_counts: description: For email question types, how many are new, known, or unknown contacts. properties: known: description: The number of known contacts that responded to this survey. title: Known Contacts Count type: integer new: description: The number of new contacts that responded to this survey. title: New Contacts Count type: integer unknown: description: The number of unknown contacts that responded to this survey. title: Unknown Contacts Count type: integer title: Contact Counts type: object has_other: description: Whether this survey question has an 'other' option. readOnly: true title: Has Other Option type: boolean id: description: The ID of the survey question. readOnly: true title: Survey Question ID type: string is_required: description: Whether this survey question is required to answer. readOnly: true title: Is Required type: boolean merge_field: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer label: description: The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. readOnly: true title: Merge Field Label type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string readOnly: true title: Merge Field type: object options: description: The answer choices for this question. items: properties: count: description: The count of responses that selected this survey question option. title: Response Count type: integer id: description: The ID for this survey question option. title: Option ID type: string label: description: The label for this survey question option. title: Option Label type: string type: object readOnly: true title: Options type: array other_label: description: Label used for the 'other' option of this survey question. readOnly: true title: Other Option Label type: string placeholder_label: description: Placeholder text for this survey question's answer box. readOnly: true title: Placeholder Label type: string query: description: The query of the survey question. readOnly: true title: Query Text type: string range_high_label: description: Label for the high end of the range. readOnly: true title: Range High Label type: string range_low_label: description: Label for the low end of the range. readOnly: true title: Range Low Label type: string subscribe_checkbox_enabled: description: Whether the subscribe checkbox is shown for this email question. readOnly: true title: Is Subscribe Checkbox Enabled type: boolean subscribe_checkbox_label: description: Label used for the subscribe checkbox for this email question. readOnly: true title: Subscribe Checkbox Label type: string survey_id: description: The unique ID of the survey. readOnly: true title: Survey ID type: string total_responses: description: The total number of responses to this question. example: 810 readOnly: true title: Total Responses type: integer type: description: The response type of the survey question. enum: - pickOne - pickMany - range - text - email readOnly: true title: Response Type type: string title: Survey Question Report type: object title: Question Reports 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: properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array questions: description: An array of reports for each question on the survey. items: description: The details of a survey question's report. properties: average_rating: description: The average rating for this range question. example: 2.5 format: float readOnly: true title: Average Rating for a Range Question type: number contact_counts: description: For email question types, how many are new, known, or unknown contacts. properties: known: description: The number of known contacts that responded to this survey. title: Known Contacts Count type: integer new: description: The number of new contacts that responded to this survey. title: New Contacts Count type: integer unknown: description: The number of unknown contacts that responded to this survey. title: Unknown Contacts Count type: integer title: Contact Counts type: object has_other: description: Whether this survey question has an 'other' option. readOnly: true title: Has Other Option type: boolean id: description: The ID of the survey question. readOnly: true title: Survey Question ID type: string is_required: description: Whether this survey question is required to answer. readOnly: true title: Is Required type: boolean merge_field: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer label: description: The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. readOnly: true title: Merge Field Label type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string readOnly: true title: Merge Field type: object options: description: The answer choices for this question. items: properties: count: description: The count of responses that selected this survey question option. title: Response Count type: integer id: description: The ID for this survey question option. title: Option ID type: string label: description: The label for this survey question option. title: Option Label type: string type: object readOnly: true title: Options type: array other_label: description: Label used for the 'other' option of this survey question. readOnly: true title: Other Option Label type: string placeholder_label: description: Placeholder text for this survey question's answer box. readOnly: true title: Placeholder Label type: string query: description: The query of the survey question. readOnly: true title: Query Text type: string range_high_label: description: Label for the high end of the range. readOnly: true title: Range High Label type: string range_low_label: description: Label for the low end of the range. readOnly: true title: Range Low Label type: string subscribe_checkbox_enabled: description: Whether the subscribe checkbox is shown for this email question. readOnly: true title: Is Subscribe Checkbox Enabled type: boolean subscribe_checkbox_label: description: Label used for the subscribe checkbox for this email question. readOnly: true title: Subscribe Checkbox Label type: string survey_id: description: The unique ID of the survey. readOnly: true title: Survey ID type: string total_responses: description: The total number of responses to this question. example: 810 readOnly: true title: Total Responses type: integer type: description: The response type of the survey question. enum: - pickOne - pickMany - range - text - email readOnly: true title: Response Type type: string title: Survey Question Report type: object title: Question Reports 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: List of Survey Question Report Instances 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 survey question reports tags: - reporting x-custom-config: methodNameCamel: getSurveyQuestionReportsAll methodNameSnake: get_survey_question_reports_all "/reporting/surveys/{outreach_id}/questions/{question_id}": get: description: Get report for a survey question. operationId: getReportingSurveysIdQuestionsId 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 outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID - description: The ID of the survey question. in: path name: question_id required: true schema: type: string x-title: Question ID responses: "200": content: application/json: schema: description: The details of a survey question's report. properties: average_rating: description: The average rating for this range question. example: 2.5 format: float readOnly: true title: Average Rating for a Range Question type: number contact_counts: description: For email question types, how many are new, known, or unknown contacts. properties: known: description: The number of known contacts that responded to this survey. title: Known Contacts Count type: integer new: description: The number of new contacts that responded to this survey. title: New Contacts Count type: integer unknown: description: The number of unknown contacts that responded to this survey. title: Unknown Contacts Count type: integer title: Contact Counts type: object has_other: description: Whether this survey question has an 'other' option. readOnly: true title: Has Other Option type: boolean id: description: The ID of the survey question. readOnly: true title: Survey Question ID type: string is_required: description: Whether this survey question is required to answer. readOnly: true title: Is Required type: boolean merge_field: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer label: description: The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. readOnly: true title: Merge Field Label type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string readOnly: true title: Merge Field type: object options: description: The answer choices for this question. items: properties: count: description: The count of responses that selected this survey question option. title: Response Count type: integer id: description: The ID for this survey question option. title: Option ID type: string label: description: The label for this survey question option. title: Option Label type: string type: object readOnly: true title: Options type: array other_label: description: Label used for the 'other' option of this survey question. readOnly: true title: Other Option Label type: string placeholder_label: description: Placeholder text for this survey question's answer box. readOnly: true title: Placeholder Label type: string query: description: The query of the survey question. readOnly: true title: Query Text type: string range_high_label: description: Label for the high end of the range. readOnly: true title: Range High Label type: string range_low_label: description: Label for the low end of the range. readOnly: true title: Range Low Label type: string subscribe_checkbox_enabled: description: Whether the subscribe checkbox is shown for this email question. readOnly: true title: Is Subscribe Checkbox Enabled type: boolean subscribe_checkbox_label: description: Label used for the subscribe checkbox for this email question. readOnly: true title: Subscribe Checkbox Label type: string survey_id: description: The unique ID of the survey. readOnly: true title: Survey ID type: string total_responses: description: The total number of responses to this question. example: 810 readOnly: true title: Total Responses type: integer type: description: The response type of the survey question. enum: - pickOne - pickMany - range - text - email readOnly: true title: Response Type type: string title: Survey Question Report type: object application/problem+json: schema: description: The details of a survey question's report. properties: average_rating: description: The average rating for this range question. example: 2.5 format: float readOnly: true title: Average Rating for a Range Question type: number contact_counts: description: For email question types, how many are new, known, or unknown contacts. properties: known: description: The number of known contacts that responded to this survey. title: Known Contacts Count type: integer new: description: The number of new contacts that responded to this survey. title: New Contacts Count type: integer unknown: description: The number of unknown contacts that responded to this survey. title: Unknown Contacts Count type: integer title: Contact Counts type: object has_other: description: Whether this survey question has an 'other' option. readOnly: true title: Has Other Option type: boolean id: description: The ID of the survey question. readOnly: true title: Survey Question ID type: string is_required: description: Whether this survey question is required to answer. readOnly: true title: Is Required type: boolean merge_field: description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: id: description: An unchanging id for the merge field. readOnly: true title: Merge Field ID type: integer label: description: The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. readOnly: true title: Merge Field Label type: string type: description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true title: Merge Field Type type: string readOnly: true title: Merge Field type: object options: description: The answer choices for this question. items: properties: count: description: The count of responses that selected this survey question option. title: Response Count type: integer id: description: The ID for this survey question option. title: Option ID type: string label: description: The label for this survey question option. title: Option Label type: string type: object readOnly: true title: Options type: array other_label: description: Label used for the 'other' option of this survey question. readOnly: true title: Other Option Label type: string placeholder_label: description: Placeholder text for this survey question's answer box. readOnly: true title: Placeholder Label type: string query: description: The query of the survey question. readOnly: true title: Query Text type: string range_high_label: description: Label for the high end of the range. readOnly: true title: Range High Label type: string range_low_label: description: Label for the low end of the range. readOnly: true title: Range Low Label type: string subscribe_checkbox_enabled: description: Whether the subscribe checkbox is shown for this email question. readOnly: true title: Is Subscribe Checkbox Enabled type: boolean subscribe_checkbox_label: description: Label used for the subscribe checkbox for this email question. readOnly: true title: Subscribe Checkbox Label type: string survey_id: description: The unique ID of the survey. readOnly: true title: Survey ID type: string total_responses: description: The total number of responses to this question. example: 810 readOnly: true title: Total Responses type: integer type: description: The response type of the survey question. enum: - pickOne - pickMany - range - text - email readOnly: true title: Response Type type: string title: Survey Question Report type: object description: Survey Question Report Instance 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 survey question report tags: - reporting x-custom-config: methodNameCamel: getSurveyQuestionReport methodNameSnake: get_survey_question_report "/reporting/surveys/{outreach_id}/questions/{question_id}/answers": get: description: Get answers for a survey question. operationId: getReportingSurveysIdQuestionsIdAnswers 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 outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID - description: The ID of the survey question. in: path name: question_id required: true schema: type: string x-title: Question ID - description: Filter survey responses by familiarity of the respondents. in: query name: respondent_familiarity_is required: false schema: enum: - new - known - unknown type: string x-title: Respondent Familiarity Is responses: "200": content: application/json: schema: properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array answers: description: An array of answers for a question on the survey. items: description: The details of a survey question's answer. properties: contact: description: Information about the contact. properties: avatar_url: description: URL for the contact's avatar or profile image. readOnly: true title: Avatar URL type: string consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: The ID of this contact. readOnly: true title: Contact ID type: string email: description: The contact's email address. readOnly: true title: Contact Email type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string status: description: The contact's current status. enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived readOnly: true title: Contact Status type: string readOnly: true title: Contact type: object id: description: The ID of the answer. readOnly: true title: Answer ID type: string is_new_contact: description: If this contact was added to the Mailchimp audience via this survey. readOnly: false title: Is New Contact type: boolean response_id: description: The ID of the survey response. readOnly: true title: Response ID type: string submitted_at: description: The date and time when the survey response was submitted in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string value: description: The raw text answer. readOnly: true title: Value type: string title: Survey Question Answer type: object title: Answers 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: properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array answers: description: An array of answers for a question on the survey. items: description: The details of a survey question's answer. properties: contact: description: Information about the contact. properties: avatar_url: description: URL for the contact's avatar or profile image. readOnly: true title: Avatar URL type: string consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: The ID of this contact. readOnly: true title: Contact ID type: string email: description: The contact's email address. readOnly: true title: Contact Email type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string status: description: The contact's current status. enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived readOnly: true title: Contact Status type: string readOnly: true title: Contact type: object id: description: The ID of the answer. readOnly: true title: Answer ID type: string is_new_contact: description: If this contact was added to the Mailchimp audience via this survey. readOnly: false title: Is New Contact type: boolean response_id: description: The ID of the survey response. readOnly: true title: Response ID type: string submitted_at: description: The date and time when the survey response was submitted in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string value: description: The raw text answer. readOnly: true title: Value type: string title: Survey Question Answer type: object title: Answers 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: List of Survey Question Answers 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 answers for question tags: - reporting x-custom-config: methodNameCamel: getSurveyQuestionAnswers methodNameSnake: get_survey_question_answers "/reporting/surveys/{outreach_id}/responses": get: description: Get responses to a survey. operationId: getReportingSurveysIdResponses 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 outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID - description: The ID of the question that was answered. in: query name: answered_question required: false schema: type: integer x-title: Answered Question - description: The ID of the option chosen to filter responses on. in: query name: chose_answer required: false schema: type: string x-title: Chose Answer - description: Filter survey responses by familiarity of the respondents. in: query name: respondent_familiarity_is required: false schema: enum: - new - known - unknown type: string x-title: Respondent Familiarity Is responses: "200": content: application/json: schema: properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array responses: description: An array of responses to a survey. items: description: Survey respondent details. properties: contact: description: Information about the contact. properties: avatar_url: description: URL for the contact's avatar or profile image. readOnly: true title: Avatar URL type: string consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: The ID of this contact. readOnly: true title: Contact ID type: string email: description: The contact's email address. readOnly: true title: Contact Email type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string status: description: The contact's current status. enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived readOnly: true title: Contact Status type: string readOnly: true title: Contact type: object is_new_contact: description: If this contact was added to the Mailchimp audience via this survey. readOnly: false title: Is New Contact type: boolean response_id: description: The ID for the survey response. readOnly: true title: Response ID type: string submitted_at: description: The date and time when the survey response was submitted in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string title: Survey Respondents type: object title: Responses 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: properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array responses: description: An array of responses to a survey. items: description: Survey respondent details. properties: contact: description: Information about the contact. properties: avatar_url: description: URL for the contact's avatar or profile image. readOnly: true title: Avatar URL type: string consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: The ID of this contact. readOnly: true title: Contact ID type: string email: description: The contact's email address. readOnly: true title: Contact Email type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string status: description: The contact's current status. enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived readOnly: true title: Contact Status type: string readOnly: true title: Contact type: object is_new_contact: description: If this contact was added to the Mailchimp audience via this survey. readOnly: false title: Is New Contact type: boolean response_id: description: The ID for the survey response. readOnly: true title: Response ID type: string submitted_at: description: The date and time when the survey response was submitted in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string title: Survey Respondents type: object title: Responses 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: List of survey responses 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 survey responses tags: - reporting x-custom-config: methodNameCamel: getSurveyResponsesAll methodNameSnake: get_survey_responses_all "/reporting/surveys/{outreach_id}/responses/{response_id}": get: description: Get a single survey response. operationId: getReportingSurveysIdResponsesId parameters: - description: The outreach id. in: path name: outreach_id required: true schema: type: string x-title: Outreach ID - description: The ID of the survey response. in: path name: response_id required: true schema: type: string x-title: Response ID responses: "200": content: application/json: schema: description: A single survey response. properties: contact: description: Information about the contact. properties: avatar_url: description: URL for the contact's avatar or profile image. readOnly: true title: Avatar URL type: string consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: The ID of this contact. readOnly: true title: Contact ID type: string email: description: The contact's email address. readOnly: true title: Contact Email type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string status: description: The contact's current status. enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived readOnly: true title: Contact Status type: string readOnly: true title: Contact type: object is_new_contact: description: If this contact was added to the Mailchimp audience via this survey. readOnly: false title: Is New Contact type: boolean response_id: description: The ID for the survey response. readOnly: true title: Response ID type: string results: description: The survey questions and the answers to those questions. items: description: A single question and the response to that question. properties: answer: description: The answer to this survey question. title: Answer type: string query: description: The survey question. title: Question Query type: string question_id: description: The unique ID for this question. title: Question ID type: string question_type: description: The type of question this is. enum: - pickOne - pickMany - range - text - email title: Question Type type: string title: Response type: object title: Results type: array submitted_at: description: The date and time when the survey response was submitted in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string title: Survey Response type: object application/problem+json: schema: description: A single survey response. properties: contact: description: Information about the contact. properties: avatar_url: description: URL for the contact's avatar or profile image. readOnly: true title: Avatar URL type: string consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: The ID of this contact. readOnly: true title: Contact ID type: string email: description: The contact's email address. readOnly: true title: Contact Email type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string status: description: The contact's current status. enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived readOnly: true title: Contact Status type: string readOnly: true title: Contact type: object is_new_contact: description: If this contact was added to the Mailchimp audience via this survey. readOnly: false title: Is New Contact type: boolean response_id: description: The ID for the survey response. readOnly: true title: Response ID type: string results: description: The survey questions and the answers to those questions. items: description: A single question and the response to that question. properties: answer: description: The answer to this survey question. title: Answer type: string query: description: The survey question. title: Question Query type: string question_id: description: The unique ID for this question. title: Question ID type: string question_type: description: The type of question this is. enum: - pickOne - pickMany - range - text - email title: Question Type type: string title: Response type: object title: Results type: array submitted_at: description: The date and time when the survey response was submitted in ISO 8601 format. format: date-time readOnly: true title: Submitted At type: string title: Survey Response type: object description: Get a single survey 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: Get survey response tags: - reporting x-custom-config: methodNameCamel: getSurveyResponse methodNameSnake: get_survey_response /reports: get: deprecated: false description: Get campaign reports. operationId: getReports 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: "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 responses: "200": content: application/json: schema: description: A list of reports containing campaigns marked as Sent. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array reports: description: An array of objects, each representing a report resource. items: description: Report details about a sent 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 ab_split: description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Campaign A. properties: abuse_reports: description: Abuse reports for Campaign A. title: Abuse Reports type: integer bounces: description: Bounces for Campaign A. title: Bounces type: integer forwards: description: Forwards for Campaign A. title: Forwards type: integer forwards_opens: description: Opens from forwards for Campaign A. title: Forward Opens type: integer last_open: description: The last open for Campaign A. title: Last Open type: string opens: description: Opens for Campaign A. title: Opens type: integer recipient_clicks: description: Recipient Clicks for Campaign A. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign A. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign A. title: Unsubscribes type: integer title: Campaign A type: object b: description: Stats for Campaign B. properties: abuse_reports: description: Abuse reports for Campaign B. title: Abuse Reports type: integer bounces: description: Bounces for Campaign B. title: Bounces type: integer forwards: description: Forwards for Campaign B. title: Forwards type: integer forwards_opens: description: Opens for forwards from Campaign B. title: Forward Opens type: integer last_open: description: The last open for Campaign B. title: Last Open type: string opens: description: Opens for Campaign B. title: Opens type: integer recipient_clicks: description: Recipients clicks for Campaign B. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign B. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign B. title: Unsubscribes type: integer title: Campaign B type: object title: A/B Split Stats type: object abuse_reports: description: The number of abuse reports generated for this campaign. title: Abuse Reports type: integer bounces: description: An object describing the bounce summary for the campaign. properties: hard_bounces: description: The total number of hard bounced email addresses. title: Hard Bounces type: integer soft_bounces: description: The total number of soft bounced email addresses. title: Soft Bounces type: integer syntax_errors: description: The total number of addresses that were syntax-related bounces. title: Syntax Errors type: integer title: Bounces type: object campaign_title: description: The title of the campaign. readOnly: true title: Campaign Title type: string clicks: description: An object describing the click activity for the campaign. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. title: Click Rate type: number clicks_total: description: The total number of clicks for the campaign. title: Total Clicks type: integer last_click: description: The date and time of the last recorded click for the campaign in ISO 8601 format. format: date-time title: Last Click type: string unique_clicks: description: The total number of unique clicks for links across a campaign. title: Unique Clicks type: integer unique_subscriber_clicks: description: The total number of subscribers who clicked on a campaign. title: Unique Subscriber Clicks type: integer title: Clicks type: object 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 ecommerce: description: E-Commerce stats for a campaign. properties: currency_code: example: USD readOnly: true title: Three letter currency code for this user type: string 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 emails_sent: description: The total number of emails sent for this campaign. title: Emails Sent type: integer facebook_likes: description: An object describing campaign engagement on Facebook. properties: facebook_likes: description: The number of Facebook likes for the campaign. title: Facebook Likes type: integer recipient_likes: description: The number of recipients who liked the campaign on Facebook. title: Recipient Likes type: integer unique_likes: description: The number of unique likes. title: Unique Likes type: integer title: Facebook Likes type: object forwards: description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: description: How many times the campaign has been forwarded. title: Total Forwards type: integer forwards_opens: description: How many times the forwarded campaign has been opened. title: Forward Opens type: integer title: Forwards type: object id: description: A string that uniquely identifies this campaign. title: Campaign ID type: string industry_stats: description: The average campaign statistics for your industry. properties: abuse_rate: description: The industry abuse rate. title: Abuse Rate type: number bounce_rate: description: The industry bounce rate. title: Bounce Rate type: number click_rate: description: The industry click rate. title: Click Rate type: number open_rate: description: The industry open rate. title: Open Rate type: number type: description: "The type of business industry associated with your account. For example: retail, education, etc." title: Industry Type type: string unopen_rate: description: The industry unopened rate. title: Unopened Rate type: number unsub_rate: description: The industry unsubscribe rate. title: Unsubscribe Rate type: number title: Industry Stats type: object list_id: description: The unique list id. 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 list_name: description: The name of the list. readOnly: true title: List Name type: string list_stats: description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Click Rate type: number open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Open Rate type: number sub_rate: description: The average number of subscriptions per month for the list. readOnly: true title: Average Subscription Rate type: number unsub_rate: description: The average number of unsubscriptions per month for the list. readOnly: true title: Average Unsubscription Rate type: number title: List Stats type: object opens: description: An object describing the open activity for the campaign. properties: last_open: description: The date and time of the last recorded open in ISO 8601 format. format: date-time title: Last Open type: string open_rate: description: The number of unique opens divided by the total number of successful deliveries. title: Open Rate type: number opens_total: description: The total number of opens for a campaign. title: Total Opens type: integer unique_opens: description: The total number of unique opens. title: Unique Opens type: integer title: Opens type: object preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string rss_last_send: description: For RSS campaigns, the date and time of the last send in ISO 8601 format. format: date-time readOnly: true title: RSS Last Send type: string 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 share_report: description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_password: description: If password protected, the password for the VIP report. readOnly: true title: Report Password type: string share_url: description: The URL for the VIP report. readOnly: true title: Report URL type: string title: Share Report type: object subject_line: description: The subject line for the campaign. readOnly: true title: Campaign Subject Line type: string timeseries: description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: properties: emails_sent: description: The number of emails sent in the timeseries. title: Emails Sent type: integer recipients_clicks: description: The number of clicks in the timeseries. title: Recipient Clicks type: integer timestamp: description: The date and time for the series in ISO 8601 format. format: date-time title: Timestamp type: string unique_opens: description: The number of unique opens in the timeseries. title: Unique Opens type: integer type: object title: Timeseries type: array timewarp: description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: properties: bounces: description: The number of bounces. title: Bounces type: integer clicks: description: The number of clicks. title: Clicks type: integer gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_click: description: The date and time of the last click in ISO 8601 format. format: date-time title: Last Click type: string last_open: description: The date and time of the last open in ISO 8601 format. format: date-time title: Last Open type: string opens: description: The number of opens. title: Opens type: integer unique_clicks: description: The number of unique clicks. title: Unique Clicks type: integer unique_opens: description: The number of unique opens. title: Unique Opens type: integer type: object title: Timewarp Stats type: array type: description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). title: Campaign Type type: string unsubscribed: description: The total number of unsubscribed members for this campaign. readOnly: true title: Unsubscribe Count type: integer title: Campaign Report type: object title: Lists 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 list of reports containing campaigns marked as Sent. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array reports: description: An array of objects, each representing a report resource. items: description: Report details about a sent 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 ab_split: description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Campaign A. properties: abuse_reports: description: Abuse reports for Campaign A. title: Abuse Reports type: integer bounces: description: Bounces for Campaign A. title: Bounces type: integer forwards: description: Forwards for Campaign A. title: Forwards type: integer forwards_opens: description: Opens from forwards for Campaign A. title: Forward Opens type: integer last_open: description: The last open for Campaign A. title: Last Open type: string opens: description: Opens for Campaign A. title: Opens type: integer recipient_clicks: description: Recipient Clicks for Campaign A. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign A. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign A. title: Unsubscribes type: integer title: Campaign A type: object b: description: Stats for Campaign B. properties: abuse_reports: description: Abuse reports for Campaign B. title: Abuse Reports type: integer bounces: description: Bounces for Campaign B. title: Bounces type: integer forwards: description: Forwards for Campaign B. title: Forwards type: integer forwards_opens: description: Opens for forwards from Campaign B. title: Forward Opens type: integer last_open: description: The last open for Campaign B. title: Last Open type: string opens: description: Opens for Campaign B. title: Opens type: integer recipient_clicks: description: Recipients clicks for Campaign B. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign B. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign B. title: Unsubscribes type: integer title: Campaign B type: object title: A/B Split Stats type: object abuse_reports: description: The number of abuse reports generated for this campaign. title: Abuse Reports type: integer bounces: description: An object describing the bounce summary for the campaign. properties: hard_bounces: description: The total number of hard bounced email addresses. title: Hard Bounces type: integer soft_bounces: description: The total number of soft bounced email addresses. title: Soft Bounces type: integer syntax_errors: description: The total number of addresses that were syntax-related bounces. title: Syntax Errors type: integer title: Bounces type: object campaign_title: description: The title of the campaign. readOnly: true title: Campaign Title type: string clicks: description: An object describing the click activity for the campaign. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. title: Click Rate type: number clicks_total: description: The total number of clicks for the campaign. title: Total Clicks type: integer last_click: description: The date and time of the last recorded click for the campaign in ISO 8601 format. format: date-time title: Last Click type: string unique_clicks: description: The total number of unique clicks for links across a campaign. title: Unique Clicks type: integer unique_subscriber_clicks: description: The total number of subscribers who clicked on a campaign. title: Unique Subscriber Clicks type: integer title: Clicks type: object 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 ecommerce: description: E-Commerce stats for a campaign. properties: currency_code: example: USD readOnly: true title: Three letter currency code for this user type: string 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 emails_sent: description: The total number of emails sent for this campaign. title: Emails Sent type: integer facebook_likes: description: An object describing campaign engagement on Facebook. properties: facebook_likes: description: The number of Facebook likes for the campaign. title: Facebook Likes type: integer recipient_likes: description: The number of recipients who liked the campaign on Facebook. title: Recipient Likes type: integer unique_likes: description: The number of unique likes. title: Unique Likes type: integer title: Facebook Likes type: object forwards: description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: description: How many times the campaign has been forwarded. title: Total Forwards type: integer forwards_opens: description: How many times the forwarded campaign has been opened. title: Forward Opens type: integer title: Forwards type: object id: description: A string that uniquely identifies this campaign. title: Campaign ID type: string industry_stats: description: The average campaign statistics for your industry. properties: abuse_rate: description: The industry abuse rate. title: Abuse Rate type: number bounce_rate: description: The industry bounce rate. title: Bounce Rate type: number click_rate: description: The industry click rate. title: Click Rate type: number open_rate: description: The industry open rate. title: Open Rate type: number type: description: "The type of business industry associated with your account. For example: retail, education, etc." title: Industry Type type: string unopen_rate: description: The industry unopened rate. title: Unopened Rate type: number unsub_rate: description: The industry unsubscribe rate. title: Unsubscribe Rate type: number title: Industry Stats type: object list_id: description: The unique list id. 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 list_name: description: The name of the list. readOnly: true title: List Name type: string list_stats: description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Click Rate type: number open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Open Rate type: number sub_rate: description: The average number of subscriptions per month for the list. readOnly: true title: Average Subscription Rate type: number unsub_rate: description: The average number of unsubscriptions per month for the list. readOnly: true title: Average Unsubscription Rate type: number title: List Stats type: object opens: description: An object describing the open activity for the campaign. properties: last_open: description: The date and time of the last recorded open in ISO 8601 format. format: date-time title: Last Open type: string open_rate: description: The number of unique opens divided by the total number of successful deliveries. title: Open Rate type: number opens_total: description: The total number of opens for a campaign. title: Total Opens type: integer unique_opens: description: The total number of unique opens. title: Unique Opens type: integer title: Opens type: object preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string rss_last_send: description: For RSS campaigns, the date and time of the last send in ISO 8601 format. format: date-time readOnly: true title: RSS Last Send type: string 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 share_report: description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_password: description: If password protected, the password for the VIP report. readOnly: true title: Report Password type: string share_url: description: The URL for the VIP report. readOnly: true title: Report URL type: string title: Share Report type: object subject_line: description: The subject line for the campaign. readOnly: true title: Campaign Subject Line type: string timeseries: description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: properties: emails_sent: description: The number of emails sent in the timeseries. title: Emails Sent type: integer recipients_clicks: description: The number of clicks in the timeseries. title: Recipient Clicks type: integer timestamp: description: The date and time for the series in ISO 8601 format. format: date-time title: Timestamp type: string unique_opens: description: The number of unique opens in the timeseries. title: Unique Opens type: integer type: object title: Timeseries type: array timewarp: description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: properties: bounces: description: The number of bounces. title: Bounces type: integer clicks: description: The number of clicks. title: Clicks type: integer gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_click: description: The date and time of the last click in ISO 8601 format. format: date-time title: Last Click type: string last_open: description: The date and time of the last open in ISO 8601 format. format: date-time title: Last Open type: string opens: description: The number of opens. title: Opens type: integer unique_clicks: description: The number of unique clicks. title: Unique Clicks type: integer unique_opens: description: The number of unique opens. title: Unique Opens type: integer type: object title: Timewarp Stats type: array type: description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). title: Campaign Type type: string unsubscribed: description: The total number of unsubscribed members for this campaign. readOnly: true title: Unsubscribe Count type: integer title: Campaign Report type: object title: Lists 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 reports tags: - reports x-custom-config: methodNameCamel: getAllCampaignReports methodNameSnake: get_all_campaign_reports "/reports/{campaign_id}": get: deprecated: false description: Get report details for a specific sent campaign. operationId: getReportsId 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: Report details about a sent 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 ab_split: description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Campaign A. properties: abuse_reports: description: Abuse reports for Campaign A. title: Abuse Reports type: integer bounces: description: Bounces for Campaign A. title: Bounces type: integer forwards: description: Forwards for Campaign A. title: Forwards type: integer forwards_opens: description: Opens from forwards for Campaign A. title: Forward Opens type: integer last_open: description: The last open for Campaign A. title: Last Open type: string opens: description: Opens for Campaign A. title: Opens type: integer recipient_clicks: description: Recipient Clicks for Campaign A. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign A. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign A. title: Unsubscribes type: integer title: Campaign A type: object b: description: Stats for Campaign B. properties: abuse_reports: description: Abuse reports for Campaign B. title: Abuse Reports type: integer bounces: description: Bounces for Campaign B. title: Bounces type: integer forwards: description: Forwards for Campaign B. title: Forwards type: integer forwards_opens: description: Opens for forwards from Campaign B. title: Forward Opens type: integer last_open: description: The last open for Campaign B. title: Last Open type: string opens: description: Opens for Campaign B. title: Opens type: integer recipient_clicks: description: Recipients clicks for Campaign B. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign B. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign B. title: Unsubscribes type: integer title: Campaign B type: object title: A/B Split Stats type: object abuse_reports: description: The number of abuse reports generated for this campaign. title: Abuse Reports type: integer bounces: description: An object describing the bounce summary for the campaign. properties: hard_bounces: description: The total number of hard bounced email addresses. title: Hard Bounces type: integer soft_bounces: description: The total number of soft bounced email addresses. title: Soft Bounces type: integer syntax_errors: description: The total number of addresses that were syntax-related bounces. title: Syntax Errors type: integer title: Bounces type: object campaign_title: description: The title of the campaign. readOnly: true title: Campaign Title type: string clicks: description: An object describing the click activity for the campaign. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. title: Click Rate type: number clicks_total: description: The total number of clicks for the campaign. title: Total Clicks type: integer last_click: description: The date and time of the last recorded click for the campaign in ISO 8601 format. format: date-time title: Last Click type: string unique_clicks: description: The total number of unique clicks for links across a campaign. title: Unique Clicks type: integer unique_subscriber_clicks: description: The total number of subscribers who clicked on a campaign. title: Unique Subscriber Clicks type: integer title: Clicks type: object 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 ecommerce: description: E-Commerce stats for a campaign. properties: currency_code: example: USD readOnly: true title: Three letter currency code for this user type: string 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 emails_sent: description: The total number of emails sent for this campaign. title: Emails Sent type: integer facebook_likes: description: An object describing campaign engagement on Facebook. properties: facebook_likes: description: The number of Facebook likes for the campaign. title: Facebook Likes type: integer recipient_likes: description: The number of recipients who liked the campaign on Facebook. title: Recipient Likes type: integer unique_likes: description: The number of unique likes. title: Unique Likes type: integer title: Facebook Likes type: object forwards: description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: description: How many times the campaign has been forwarded. title: Total Forwards type: integer forwards_opens: description: How many times the forwarded campaign has been opened. title: Forward Opens type: integer title: Forwards type: object id: description: A string that uniquely identifies this campaign. title: Campaign ID type: string industry_stats: description: The average campaign statistics for your industry. properties: abuse_rate: description: The industry abuse rate. title: Abuse Rate type: number bounce_rate: description: The industry bounce rate. title: Bounce Rate type: number click_rate: description: The industry click rate. title: Click Rate type: number open_rate: description: The industry open rate. title: Open Rate type: number type: description: "The type of business industry associated with your account. For example: retail, education, etc." title: Industry Type type: string unopen_rate: description: The industry unopened rate. title: Unopened Rate type: number unsub_rate: description: The industry unsubscribe rate. title: Unsubscribe Rate type: number title: Industry Stats type: object list_id: description: The unique list id. 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 list_name: description: The name of the list. readOnly: true title: List Name type: string list_stats: description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Click Rate type: number open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Open Rate type: number sub_rate: description: The average number of subscriptions per month for the list. readOnly: true title: Average Subscription Rate type: number unsub_rate: description: The average number of unsubscriptions per month for the list. readOnly: true title: Average Unsubscription Rate type: number title: List Stats type: object opens: description: An object describing the open activity for the campaign. properties: last_open: description: The date and time of the last recorded open in ISO 8601 format. format: date-time title: Last Open type: string open_rate: description: The number of unique opens divided by the total number of successful deliveries. title: Open Rate type: number opens_total: description: The total number of opens for a campaign. title: Total Opens type: integer unique_opens: description: The total number of unique opens. title: Unique Opens type: integer title: Opens type: object preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string rss_last_send: description: For RSS campaigns, the date and time of the last send in ISO 8601 format. format: date-time readOnly: true title: RSS Last Send type: string 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 share_report: description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_password: description: If password protected, the password for the VIP report. readOnly: true title: Report Password type: string share_url: description: The URL for the VIP report. readOnly: true title: Report URL type: string title: Share Report type: object subject_line: description: The subject line for the campaign. readOnly: true title: Campaign Subject Line type: string timeseries: description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: properties: emails_sent: description: The number of emails sent in the timeseries. title: Emails Sent type: integer recipients_clicks: description: The number of clicks in the timeseries. title: Recipient Clicks type: integer timestamp: description: The date and time for the series in ISO 8601 format. format: date-time title: Timestamp type: string unique_opens: description: The number of unique opens in the timeseries. title: Unique Opens type: integer type: object title: Timeseries type: array timewarp: description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: properties: bounces: description: The number of bounces. title: Bounces type: integer clicks: description: The number of clicks. title: Clicks type: integer gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_click: description: The date and time of the last click in ISO 8601 format. format: date-time title: Last Click type: string last_open: description: The date and time of the last open in ISO 8601 format. format: date-time title: Last Open type: string opens: description: The number of opens. title: Opens type: integer unique_clicks: description: The number of unique clicks. title: Unique Clicks type: integer unique_opens: description: The number of unique opens. title: Unique Opens type: integer type: object title: Timewarp Stats type: array type: description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). title: Campaign Type type: string unsubscribed: description: The total number of unsubscribed members for this campaign. readOnly: true title: Unsubscribe Count type: integer title: Campaign Report type: object application/problem+json: schema: description: Report details about a sent 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 ab_split: description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Campaign A. properties: abuse_reports: description: Abuse reports for Campaign A. title: Abuse Reports type: integer bounces: description: Bounces for Campaign A. title: Bounces type: integer forwards: description: Forwards for Campaign A. title: Forwards type: integer forwards_opens: description: Opens from forwards for Campaign A. title: Forward Opens type: integer last_open: description: The last open for Campaign A. title: Last Open type: string opens: description: Opens for Campaign A. title: Opens type: integer recipient_clicks: description: Recipient Clicks for Campaign A. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign A. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign A. title: Unsubscribes type: integer title: Campaign A type: object b: description: Stats for Campaign B. properties: abuse_reports: description: Abuse reports for Campaign B. title: Abuse Reports type: integer bounces: description: Bounces for Campaign B. title: Bounces type: integer forwards: description: Forwards for Campaign B. title: Forwards type: integer forwards_opens: description: Opens for forwards from Campaign B. title: Forward Opens type: integer last_open: description: The last open for Campaign B. title: Last Open type: string opens: description: Opens for Campaign B. title: Opens type: integer recipient_clicks: description: Recipients clicks for Campaign B. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign B. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign B. title: Unsubscribes type: integer title: Campaign B type: object title: A/B Split Stats type: object abuse_reports: description: The number of abuse reports generated for this campaign. title: Abuse Reports type: integer bounces: description: An object describing the bounce summary for the campaign. properties: hard_bounces: description: The total number of hard bounced email addresses. title: Hard Bounces type: integer soft_bounces: description: The total number of soft bounced email addresses. title: Soft Bounces type: integer syntax_errors: description: The total number of addresses that were syntax-related bounces. title: Syntax Errors type: integer title: Bounces type: object campaign_title: description: The title of the campaign. readOnly: true title: Campaign Title type: string clicks: description: An object describing the click activity for the campaign. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. title: Click Rate type: number clicks_total: description: The total number of clicks for the campaign. title: Total Clicks type: integer last_click: description: The date and time of the last recorded click for the campaign in ISO 8601 format. format: date-time title: Last Click type: string unique_clicks: description: The total number of unique clicks for links across a campaign. title: Unique Clicks type: integer unique_subscriber_clicks: description: The total number of subscribers who clicked on a campaign. title: Unique Subscriber Clicks type: integer title: Clicks type: object 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 ecommerce: description: E-Commerce stats for a campaign. properties: currency_code: example: USD readOnly: true title: Three letter currency code for this user type: string 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 emails_sent: description: The total number of emails sent for this campaign. title: Emails Sent type: integer facebook_likes: description: An object describing campaign engagement on Facebook. properties: facebook_likes: description: The number of Facebook likes for the campaign. title: Facebook Likes type: integer recipient_likes: description: The number of recipients who liked the campaign on Facebook. title: Recipient Likes type: integer unique_likes: description: The number of unique likes. title: Unique Likes type: integer title: Facebook Likes type: object forwards: description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: description: How many times the campaign has been forwarded. title: Total Forwards type: integer forwards_opens: description: How many times the forwarded campaign has been opened. title: Forward Opens type: integer title: Forwards type: object id: description: A string that uniquely identifies this campaign. title: Campaign ID type: string industry_stats: description: The average campaign statistics for your industry. properties: abuse_rate: description: The industry abuse rate. title: Abuse Rate type: number bounce_rate: description: The industry bounce rate. title: Bounce Rate type: number click_rate: description: The industry click rate. title: Click Rate type: number open_rate: description: The industry open rate. title: Open Rate type: number type: description: "The type of business industry associated with your account. For example: retail, education, etc." title: Industry Type type: string unopen_rate: description: The industry unopened rate. title: Unopened Rate type: number unsub_rate: description: The industry unsubscribe rate. title: Unsubscribe Rate type: number title: Industry Stats type: object list_id: description: The unique list id. 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 list_name: description: The name of the list. readOnly: true title: List Name type: string list_stats: description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Click Rate type: number open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Open Rate type: number sub_rate: description: The average number of subscriptions per month for the list. readOnly: true title: Average Subscription Rate type: number unsub_rate: description: The average number of unsubscriptions per month for the list. readOnly: true title: Average Unsubscription Rate type: number title: List Stats type: object opens: description: An object describing the open activity for the campaign. properties: last_open: description: The date and time of the last recorded open in ISO 8601 format. format: date-time title: Last Open type: string open_rate: description: The number of unique opens divided by the total number of successful deliveries. title: Open Rate type: number opens_total: description: The total number of opens for a campaign. title: Total Opens type: integer unique_opens: description: The total number of unique opens. title: Unique Opens type: integer title: Opens type: object preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string rss_last_send: description: For RSS campaigns, the date and time of the last send in ISO 8601 format. format: date-time readOnly: true title: RSS Last Send type: string 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 share_report: description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_password: description: If password protected, the password for the VIP report. readOnly: true title: Report Password type: string share_url: description: The URL for the VIP report. readOnly: true title: Report URL type: string title: Share Report type: object subject_line: description: The subject line for the campaign. readOnly: true title: Campaign Subject Line type: string timeseries: description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: properties: emails_sent: description: The number of emails sent in the timeseries. title: Emails Sent type: integer recipients_clicks: description: The number of clicks in the timeseries. title: Recipient Clicks type: integer timestamp: description: The date and time for the series in ISO 8601 format. format: date-time title: Timestamp type: string unique_opens: description: The number of unique opens in the timeseries. title: Unique Opens type: integer type: object title: Timeseries type: array timewarp: description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: properties: bounces: description: The number of bounces. title: Bounces type: integer clicks: description: The number of clicks. title: Clicks type: integer gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_click: description: The date and time of the last click in ISO 8601 format. format: date-time title: Last Click type: string last_open: description: The date and time of the last open in ISO 8601 format. format: date-time title: Last Open type: string opens: description: The number of opens. title: Opens type: integer unique_clicks: description: The number of unique clicks. title: Unique Clicks type: integer unique_opens: description: The number of unique opens. title: Unique Opens type: integer type: object title: Timewarp Stats type: array type: description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). title: Campaign Type type: string unsubscribed: description: The total number of unsubscribed members for this campaign. readOnly: true title: Unsubscribe Count type: integer title: Campaign Report 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 report tags: - reports x-custom-config: methodNameCamel: getCampaignReport methodNameSnake: get_campaign_report "/reports/{campaign_id}/abuse-reports": get: deprecated: false description: Get a list of abuse complaints for a specific campaign. operationId: getReportsIdAbuseReportsId 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 list of abuse complaints for a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array abuse_reports: description: An array of objects, each representing an abuse report resource. items: description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id for the abuse report readOnly: true title: Campaign ID type: string date: description: Date for the abuse report format: date-time readOnly: true title: Date type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The id for the abuse report readOnly: true title: Abuse Report ID type: integer list_id: description: The unique id of the list for the abuse report. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Abuse Complaint type: object title: Abuse Reports type: array campaign_id: description: The campaign id. readOnly: true title: Campaign 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: Abuse Complaints type: object application/problem+json: schema: description: A list of abuse complaints for a specific list. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array abuse_reports: description: An array of objects, each representing an abuse report resource. items: description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id for the abuse report readOnly: true title: Campaign ID type: string date: description: Date for the abuse report format: date-time readOnly: true title: Date type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The id for the abuse report readOnly: true title: Abuse Report ID type: integer list_id: description: The unique id of the list for the abuse report. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Abuse Complaint type: object title: Abuse Reports type: array campaign_id: description: The campaign id. readOnly: true title: Campaign 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: Abuse Complaints 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 abuse reports tags: - reports x-custom-config: methodNameCamel: getCampaignAbuseReports methodNameSnake: get_campaign_abuse_reports "/reports/{campaign_id}/abuse-reports/{report_id}": get: deprecated: false description: Get information about a specific abuse report for a campaign. operationId: getReportsIdAbuseReportsIdId 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 id for the abuse report. in: path name: report_id required: true schema: type: string responses: "200": content: application/json: schema: description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id for the abuse report readOnly: true title: Campaign ID type: string date: description: Date for the abuse report format: date-time readOnly: true title: Date type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The id for the abuse report readOnly: true title: Abuse Report ID type: integer list_id: description: The unique id of the list for the abuse report. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Abuse Complaint type: object application/problem+json: schema: description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id for the abuse report readOnly: true title: Campaign ID type: string date: description: Date for the abuse report format: date-time readOnly: true title: Date type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string id: description: The id for the abuse report readOnly: true title: Abuse Report ID type: integer list_id: description: The unique id of the list for the abuse report. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Abuse Complaint 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 abuse report tags: - reports x-custom-config: methodNameCamel: getCampaignAbuseReport methodNameSnake: get_campaign_abuse_report "/reports/{campaign_id}/advice": get: deprecated: false description: Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. operationId: getReportsIdAdvice 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 list of feedback based on a campaign's statistics. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array advice: description: An array of objects, each representing a point of campaign feedback. items: description: Campaign feedback details. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array message: description: The advice message. readOnly: true title: Advice Message type: string type: description: The sentiment type for a feedback message. enum: - negative - positive - neutral readOnly: true title: Advice Type type: string title: Campaign Advice type: object title: Campaign Advice type: array campaign_id: description: The campaign id. readOnly: true title: Campaign 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: Campaign Advice Report type: object application/problem+json: schema: description: A list of feedback based on a campaign's statistics. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array advice: description: An array of objects, each representing a point of campaign feedback. items: description: Campaign feedback details. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array message: description: The advice message. readOnly: true title: Advice Message type: string type: description: The sentiment type for a feedback message. enum: - negative - positive - neutral readOnly: true title: Advice Type type: string title: Campaign Advice type: object title: Campaign Advice type: array campaign_id: description: The campaign id. readOnly: true title: Campaign 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: Campaign Advice Report 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: - reports x-custom-config: methodNameCamel: getCampaignAdvice methodNameSnake: get_campaign_advice "/reports/{campaign_id}/click-details": get: deprecated: false description: Get information about clicks on specific links in your Mailchimp campaigns. operationId: getReportsIdClickDetails 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 unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID - description: Returns click reports sorted by the specified field. in: query name: sort_field required: false schema: enum: - total_clicks - unique_clicks 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: A list of URLs and unique IDs included in HTML and plain-text versions of 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer urls_clicked: description: An array of objects, each representing a specific URL contained in the campaign. items: description: A report of links clicked in 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 ab_split: description: A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Group A. properties: click_percentage_a: description: The percentage of total clicks for Group A. readOnly: true title: Click Percentage Group A type: number total_clicks_a: description: The total number of clicks for Group A. readOnly: true title: Total Clicks Group A type: integer unique_click_percentage_a: description: The percentage of unique clicks for Group A. readOnly: true title: Unique Click Percentage Group A type: number unique_clicks_a: description: The number of unique clicks for Group A. readOnly: true title: Unique Clicks Group A type: integer title: Group A type: object b: description: Stats for Group B. properties: click_percentage_b: description: The percentage of total clicks for Group B. readOnly: true title: Click Percentage Group B type: number total_clicks_b: description: The total number of clicks for Group B. readOnly: true title: Total Clicks Group B type: integer unique_click_percentage_b: description: The percentage of unique clicks for Group B. readOnly: true title: Unique Click Percentage Group B type: number unique_clicks_b: description: The number of unique clicks for Group B. readOnly: true title: Unique Clicks Group B type: integer title: Group B type: object title: A/B Split type: object campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string click_percentage: description: The percentage of total clicks a link generated for a campaign. readOnly: true title: Click Percentage type: number id: description: The unique id for the link. readOnly: true title: URL ID type: string last_click: description: The date and time for the last recorded click for a link in ISO 8601 format. format: date-time readOnly: true title: Last Click type: string total_clicks: description: The number of total clicks for a link. readOnly: true title: Total Clicks type: integer unique_click_percentage: description: The percentage of unique clicks a link generated for a campaign. readOnly: true title: Unique Click Percentage type: number unique_clicks: description: Number of unique clicks for a link. readOnly: true title: Unique Clicks type: integer url: description: The URL for the link in the campaign. readOnly: true title: URL type: string title: Click Detail Report type: object title: URLs Clicked type: array title: Click Detail Report type: object application/problem+json: schema: description: A list of URLs and unique IDs included in HTML and plain-text versions of 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer urls_clicked: description: An array of objects, each representing a specific URL contained in the campaign. items: description: A report of links clicked in 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 ab_split: description: A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Group A. properties: click_percentage_a: description: The percentage of total clicks for Group A. readOnly: true title: Click Percentage Group A type: number total_clicks_a: description: The total number of clicks for Group A. readOnly: true title: Total Clicks Group A type: integer unique_click_percentage_a: description: The percentage of unique clicks for Group A. readOnly: true title: Unique Click Percentage Group A type: number unique_clicks_a: description: The number of unique clicks for Group A. readOnly: true title: Unique Clicks Group A type: integer title: Group A type: object b: description: Stats for Group B. properties: click_percentage_b: description: The percentage of total clicks for Group B. readOnly: true title: Click Percentage Group B type: number total_clicks_b: description: The total number of clicks for Group B. readOnly: true title: Total Clicks Group B type: integer unique_click_percentage_b: description: The percentage of unique clicks for Group B. readOnly: true title: Unique Click Percentage Group B type: number unique_clicks_b: description: The number of unique clicks for Group B. readOnly: true title: Unique Clicks Group B type: integer title: Group B type: object title: A/B Split type: object campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string click_percentage: description: The percentage of total clicks a link generated for a campaign. readOnly: true title: Click Percentage type: number id: description: The unique id for the link. readOnly: true title: URL ID type: string last_click: description: The date and time for the last recorded click for a link in ISO 8601 format. format: date-time readOnly: true title: Last Click type: string total_clicks: description: The number of total clicks for a link. readOnly: true title: Total Clicks type: integer unique_click_percentage: description: The percentage of unique clicks a link generated for a campaign. readOnly: true title: Unique Click Percentage type: number unique_clicks: description: Number of unique clicks for a link. readOnly: true title: Unique Clicks type: integer url: description: The URL for the link in the campaign. readOnly: true title: URL type: string title: Click Detail Report type: object title: URLs Clicked type: array title: Click Detail Report 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 details tags: - reports x-custom-config: methodNameCamel: getCampaignClickDetails methodNameSnake: get_campaign_click_details "/reports/{campaign_id}/click-details/{link_id}": get: deprecated: false description: Get click details for a specific link in a campaign. operationId: getReportsIdClickDetailsId 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 id for the link. in: path name: link_id required: true schema: type: string x-title: Link ID responses: "200": content: application/json: schema: description: A report of links clicked in 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 ab_split: description: A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Group A. properties: click_percentage_a: description: The percentage of total clicks for Group A. readOnly: true title: Click Percentage Group A type: number total_clicks_a: description: The total number of clicks for Group A. readOnly: true title: Total Clicks Group A type: integer unique_click_percentage_a: description: The percentage of unique clicks for Group A. readOnly: true title: Unique Click Percentage Group A type: number unique_clicks_a: description: The number of unique clicks for Group A. readOnly: true title: Unique Clicks Group A type: integer title: Group A type: object b: description: Stats for Group B. properties: click_percentage_b: description: The percentage of total clicks for Group B. readOnly: true title: Click Percentage Group B type: number total_clicks_b: description: The total number of clicks for Group B. readOnly: true title: Total Clicks Group B type: integer unique_click_percentage_b: description: The percentage of unique clicks for Group B. readOnly: true title: Unique Click Percentage Group B type: number unique_clicks_b: description: The number of unique clicks for Group B. readOnly: true title: Unique Clicks Group B type: integer title: Group B type: object title: A/B Split type: object campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string click_percentage: description: The percentage of total clicks a link generated for a campaign. readOnly: true title: Click Percentage type: number id: description: The unique id for the link. readOnly: true title: URL ID type: string last_click: description: The date and time for the last recorded click for a link in ISO 8601 format. format: date-time readOnly: true title: Last Click type: string total_clicks: description: The number of total clicks for a link. readOnly: true title: Total Clicks type: integer unique_click_percentage: description: The percentage of unique clicks a link generated for a campaign. readOnly: true title: Unique Click Percentage type: number unique_clicks: description: Number of unique clicks for a link. readOnly: true title: Unique Clicks type: integer url: description: The URL for the link in the campaign. readOnly: true title: URL type: string title: Click Detail Report type: object application/problem+json: schema: description: A report of links clicked in 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 ab_split: description: A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Group A. properties: click_percentage_a: description: The percentage of total clicks for Group A. readOnly: true title: Click Percentage Group A type: number total_clicks_a: description: The total number of clicks for Group A. readOnly: true title: Total Clicks Group A type: integer unique_click_percentage_a: description: The percentage of unique clicks for Group A. readOnly: true title: Unique Click Percentage Group A type: number unique_clicks_a: description: The number of unique clicks for Group A. readOnly: true title: Unique Clicks Group A type: integer title: Group A type: object b: description: Stats for Group B. properties: click_percentage_b: description: The percentage of total clicks for Group B. readOnly: true title: Click Percentage Group B type: number total_clicks_b: description: The total number of clicks for Group B. readOnly: true title: Total Clicks Group B type: integer unique_click_percentage_b: description: The percentage of unique clicks for Group B. readOnly: true title: Unique Click Percentage Group B type: number unique_clicks_b: description: The number of unique clicks for Group B. readOnly: true title: Unique Clicks Group B type: integer title: Group B type: object title: A/B Split type: object campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string click_percentage: description: The percentage of total clicks a link generated for a campaign. readOnly: true title: Click Percentage type: number id: description: The unique id for the link. readOnly: true title: URL ID type: string last_click: description: The date and time for the last recorded click for a link in ISO 8601 format. format: date-time readOnly: true title: Last Click type: string total_clicks: description: The number of total clicks for a link. readOnly: true title: Total Clicks type: integer unique_click_percentage: description: The percentage of unique clicks a link generated for a campaign. readOnly: true title: Unique Click Percentage type: number unique_clicks: description: Number of unique clicks for a link. readOnly: true title: Unique Clicks type: integer url: description: The URL for the link in the campaign. readOnly: true title: URL type: string title: Click Detail Report 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 link details tags: - reports x-custom-config: methodNameCamel: getCampaignClickDetailsForLink methodNameSnake: get_campaign_click_details_for_link "/reports/{campaign_id}/click-details/{link_id}/members": get: deprecated: false description: Get information about list members who clicked on a specific link in a campaign. operationId: getReportsIdClickDetailsIdMembers 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 unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID - description: The id for the link. in: path name: link_id required: true schema: type: string x-title: Link ID responses: "200": content: application/json: schema: description: A collection of members who clicked on a specific link within 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string members: description: An array of objects, each representing a member who clicked a specific link within a campaign. items: description: A subscriber who clicked a specific URL in 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 campaign id. readOnly: true title: Campaign ID type: string clicks: description: The total number of times the subscriber clicked on the link. readOnly: true title: Total Clicks type: integer contact_status: description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true title: Member Status type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object url_id: description: The id for the tracked URL in the campaign. readOnly: true title: URL ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Click Detail Member type: object title: Lists type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Click Detail Members type: object application/problem+json: schema: description: A collection of members who clicked on a specific link within 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string members: description: An array of objects, each representing a member who clicked a specific link within a campaign. items: description: A subscriber who clicked a specific URL in 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 campaign id. readOnly: true title: Campaign ID type: string clicks: description: The total number of times the subscriber clicked on the link. readOnly: true title: Total Clicks type: integer contact_status: description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true title: Member Status type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object url_id: description: The id for the tracked URL in the campaign. readOnly: true title: URL ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Click Detail Member type: object title: Lists type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Click Detail Members 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 clicked link subscribers tags: - reports x-custom-config: methodNameCamel: getSubscribersInfo methodNameSnake: get_subscribers_info "/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}": get: deprecated: false description: Get information about a specific subscriber who clicked a link in a specific campaign. operationId: getReportsIdClickDetailsIdMembersId 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 id for the link. in: path name: link_id required: true schema: type: string x-title: Link ID - 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 subscriber who clicked a specific URL in 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 campaign id. readOnly: true title: Campaign ID type: string clicks: description: The total number of times the subscriber clicked on the link. readOnly: true title: Total Clicks type: integer contact_status: description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true title: Member Status type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object url_id: description: The id for the tracked URL in the campaign. readOnly: true title: URL ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Click Detail Member type: object application/problem+json: schema: description: A subscriber who clicked a specific URL in 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 campaign id. readOnly: true title: Campaign ID type: string clicks: description: The total number of times the subscriber clicked on the link. readOnly: true title: Total Clicks type: integer contact_status: description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true title: Member Status type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object url_id: description: The id for the tracked URL in the campaign. readOnly: true title: URL ID type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Click Detail Member 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 clicked link subscriber tags: - reports x-custom-config: methodNameCamel: getSubscriberInfo methodNameSnake: get_subscriber_info "/reports/{campaign_id}/domain-performance": get: deprecated: false description: Get statistics for the top-performing email domains in a campaign. operationId: getReportsIdDomainPerformance 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: Statistics for the top-performing email domains in 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 campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string domains: description: The top 5 email domains based on total delivered emails. items: description: A single email domain's performance properties: bounces: description: The number of bounces at a domain. readOnly: true title: Bounces type: integer bounces_pct: description: The percentage of total bounces from this domain. readOnly: true title: Bounces Percent type: number clicks: description: The number of clicks for a domain. readOnly: true title: Clicks type: integer clicks_pct: description: The percentage of total clicks from this domain. readOnly: true title: Clicks Percent type: number delivered: description: The number of successful deliveries for a domain. readOnly: true title: Successful Deliveries type: integer domain: description: The name of the domain (gmail.com, hotmail.com, yahoo.com). readOnly: true title: Domain type: string emails_pct: description: The percentage of total emails that went to this domain. readOnly: true title: Email Percent type: number emails_sent: description: The number of emails sent to that specific domain. readOnly: true title: Total Sent type: integer opens: description: The number of opens for a domain. readOnly: true title: Opens type: integer opens_pct: description: The percentage of total opens from this domain. readOnly: true title: Opens Percent type: number unsubs: description: The total number of unsubscribes for a domain. readOnly: true title: Unsubscribes type: integer unsubs_pct: description: The percentage of total unsubscribes from this domain. readOnly: true title: Unsubscribes Percent type: number title: Email Domain type: object readOnly: true title: Lists type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer total_sent: description: The total number of emails sent for the campaign. readOnly: true title: Total Sent type: integer title: Domain Performance type: object application/problem+json: schema: description: Statistics for the top-performing email domains in 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 campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string domains: description: The top 5 email domains based on total delivered emails. items: description: A single email domain's performance properties: bounces: description: The number of bounces at a domain. readOnly: true title: Bounces type: integer bounces_pct: description: The percentage of total bounces from this domain. readOnly: true title: Bounces Percent type: number clicks: description: The number of clicks for a domain. readOnly: true title: Clicks type: integer clicks_pct: description: The percentage of total clicks from this domain. readOnly: true title: Clicks Percent type: number delivered: description: The number of successful deliveries for a domain. readOnly: true title: Successful Deliveries type: integer domain: description: The name of the domain (gmail.com, hotmail.com, yahoo.com). readOnly: true title: Domain type: string emails_pct: description: The percentage of total emails that went to this domain. readOnly: true title: Email Percent type: number emails_sent: description: The number of emails sent to that specific domain. readOnly: true title: Total Sent type: integer opens: description: The number of opens for a domain. readOnly: true title: Opens type: integer opens_pct: description: The percentage of total opens from this domain. readOnly: true title: Opens Percent type: number unsubs: description: The total number of unsubscribes for a domain. readOnly: true title: Unsubscribes type: integer unsubs_pct: description: The percentage of total unsubscribes from this domain. readOnly: true title: Unsubscribes Percent type: number title: Email Domain type: object readOnly: true title: Lists type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer total_sent: description: The total number of emails sent for the campaign. readOnly: true title: Total Sent type: integer title: Domain Performance 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 domain performance stats tags: - reports x-custom-config: methodNameCamel: getDomainPerformanceForCampaign methodNameSnake: get_domain_performance_for_campaign "/reports/{campaign_id}/ecommerce-product-activity": get: description: Get breakdown of product activity for a campaign operationId: getReportsIdEcommerceProductActivity 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 unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID - description: Returns files sorted by the specified field. in: query name: sort_field required: false schema: enum: - title - total_revenue - total_purchased type: string x-title: Sort By Field responses: "200": content: application/json: schema: description: A collection of ecommerce 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: items: properties: currency_code: type: string image_url: type: string recommendation_purchased: type: integer recommendation_total: type: integer sku: type: string title: type: string total_purchased: type: number total_revenue: type: number type: object 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: A collection of ecommerce 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: items: properties: currency_code: type: string image_url: type: string recommendation_purchased: type: integer recommendation_total: type: integer sku: type: string title: type: string total_purchased: type: number total_revenue: type: number type: object 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: Ecommerce Product Activity Instance 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 product activity tags: - reports x-custom-config: methodNameCamel: getEcommerceProductActivityForCampaign methodNameSnake: get_ecommerce_product_activity_for_campaign "/reports/{campaign_id}/eepurl": get: deprecated: false description: Get a summary of social activity for the campaign, tracked by EepURL. operationId: getReportsIdEepurl 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 social activity for the campaign, tracked by EepURL. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 clicks: description: A summary of the click-throughs on the campaign's URL. properties: clicks: description: The total number of clicks to the campaign's URL. readOnly: true title: Clicks type: integer first_click: description: The timestamp for the first click to the URL. format: date-time readOnly: true title: First Click type: string last_click: description: The timestamp for the last click to the URL. format: date-time readOnly: true title: Last Click type: string locations: description: A summary of the top click locations. items: description: An individual click location. properties: country: description: The two-digit country code for a recorded click. title: Country type: string region: description: If available, a specific region where the click was recorded. example: NY title: Region type: string title: Location type: object readOnly: true title: Click Locations type: array readOnly: true title: Click Summary type: object eepurl: description: The shortened link used for tracking. readOnly: true title: Eepurl type: string referrers: description: A summary of the top referrers for the campaign. items: description: A single instance of a campaign referral. properties: clicks: description: The number of clicks a single referrer generated. title: Clicks type: integer first_click: description: The timestamp for the first click from this referrer. format: date-time title: First Click type: string last_click: description: The timestamp for the last click from this referrer. format: date-time title: Last Click type: string referrer: description: A referrer (truncated to 100 bytes). title: Referrer type: string title: Referrer type: object readOnly: true title: Referrers type: array x-title: Referrers total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer twitter: description: A summary of Twitter activity for a campaign. properties: first_tweet: description: The day and time of the first recorded tweet with a link to the campaign. readOnly: true title: First Tweet Timestamp type: string last_tweet: description: The day and time of the last recorded tweet with a link to the campaign. readOnly: true title: Last Tweet Timestamp type: string retweets: description: The number of retweets that include a link to the campaign. readOnly: true title: Retweet Count type: integer statuses: description: A summary of tweets that include a link to the campaign. items: description: An individual tweet. properties: datetime: description: A timestamp for the tweet. format: date-time readOnly: true title: Datetime type: string is_retweet: description: A 'true' or 'false' status of whether the tweet is a retweet. readOnly: true title: Is Retweet type: boolean screen_name: description: The Twitter handle for the author of the tweet. readOnly: true title: Screen Name type: string status: description: The body of the tweet. readOnly: true title: Status Body type: string status_id: description: The individual id for the tweet. readOnly: true title: Status ID type: string title: Twitter Status type: object readOnly: true title: Twitter Status type: array tweets: description: The number of tweets including a link to the campaign. readOnly: true title: Tweet Count type: integer title: Twitter Stats type: object title: Eepurl Activity type: object application/problem+json: schema: description: A summary of social activity for the campaign, tracked by EepURL. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 clicks: description: A summary of the click-throughs on the campaign's URL. properties: clicks: description: The total number of clicks to the campaign's URL. readOnly: true title: Clicks type: integer first_click: description: The timestamp for the first click to the URL. format: date-time readOnly: true title: First Click type: string last_click: description: The timestamp for the last click to the URL. format: date-time readOnly: true title: Last Click type: string locations: description: A summary of the top click locations. items: description: An individual click location. properties: country: description: The two-digit country code for a recorded click. title: Country type: string region: description: If available, a specific region where the click was recorded. example: NY title: Region type: string title: Location type: object readOnly: true title: Click Locations type: array readOnly: true title: Click Summary type: object eepurl: description: The shortened link used for tracking. readOnly: true title: Eepurl type: string referrers: description: A summary of the top referrers for the campaign. items: description: A single instance of a campaign referral. properties: clicks: description: The number of clicks a single referrer generated. title: Clicks type: integer first_click: description: The timestamp for the first click from this referrer. format: date-time title: First Click type: string last_click: description: The timestamp for the last click from this referrer. format: date-time title: Last Click type: string referrer: description: A referrer (truncated to 100 bytes). title: Referrer type: string title: Referrer type: object readOnly: true title: Referrers type: array x-title: Referrers total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer twitter: description: A summary of Twitter activity for a campaign. properties: first_tweet: description: The day and time of the first recorded tweet with a link to the campaign. readOnly: true title: First Tweet Timestamp type: string last_tweet: description: The day and time of the last recorded tweet with a link to the campaign. readOnly: true title: Last Tweet Timestamp type: string retweets: description: The number of retweets that include a link to the campaign. readOnly: true title: Retweet Count type: integer statuses: description: A summary of tweets that include a link to the campaign. items: description: An individual tweet. properties: datetime: description: A timestamp for the tweet. format: date-time readOnly: true title: Datetime type: string is_retweet: description: A 'true' or 'false' status of whether the tweet is a retweet. readOnly: true title: Is Retweet type: boolean screen_name: description: The Twitter handle for the author of the tweet. readOnly: true title: Screen Name type: string status: description: The body of the tweet. readOnly: true title: Status Body type: string status_id: description: The individual id for the tweet. readOnly: true title: Status ID type: string title: Twitter Status type: object readOnly: true title: Twitter Status type: array tweets: description: The number of tweets including a link to the campaign. readOnly: true title: Tweet Count type: integer title: Twitter Stats type: object title: Eepurl Activity 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 EepURL activity tags: - reports x-custom-config: methodNameCamel: getEepurlActivityForCampaign methodNameSnake: get_eepurl_activity_for_campaign "/reports/{campaign_id}/email-activity": get: deprecated: false description: Get a list of member's subscriber activity in a specific campaign. operationId: getReportsIdEmailActivity 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 unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID - description: "Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since required: false schema: type: string x-title: Email Activity since responses: "200": content: application/json: schema: description: A list of member's subscriber activity in 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 sent campaign. readOnly: true title: Campaign ID type: string emails: description: An array of members that were sent the campaign. items: description: A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign. items: description: A summary of the interaction with the campaign. properties: action: description: "One of the following actions: 'open', 'click', or 'bounce'" title: Action type: string ip: description: The IP address recorded for the action. title: IP type: string timestamp: description: The date and time recorded for the action in ISO 8601 format. format: date-time title: Timestamp type: string type: description: "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'." title: Type type: string url: description: If the action is a 'click', the URL on which the member clicked. title: URL type: string title: Member Activity type: object title: Member Activity type: array campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The unique id for the 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 title: Email Activity type: object title: Sent To type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Email Activity type: object application/problem+json: schema: description: A list of member's subscriber activity in 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 sent campaign. readOnly: true title: Campaign ID type: string emails: description: An array of members that were sent the campaign. items: description: A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign. items: description: A summary of the interaction with the campaign. properties: action: description: "One of the following actions: 'open', 'click', or 'bounce'" title: Action type: string ip: description: The IP address recorded for the action. title: IP type: string timestamp: description: The date and time recorded for the action in ISO 8601 format. format: date-time title: Timestamp type: string type: description: "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'." title: Type type: string url: description: If the action is a 'click', the URL on which the member clicked. title: URL type: string title: Member Activity type: object title: Member Activity type: array campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The unique id for the 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 title: Email Activity type: object title: Sent To type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Email Activity 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 email activity tags: - reports x-custom-config: methodNameCamel: getEmailActivityForCampaign methodNameSnake: get_email_activity_for_campaign "/reports/{campaign_id}/email-activity/{subscriber_hash}": get: deprecated: false description: Get a specific list member's activity in a campaign including opens, clicks, and bounces. operationId: getReportsIdEmailActivityId 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 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 - description: "Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since required: false schema: type: string x-title: Email Activity since responses: "200": content: application/json: schema: description: A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign. items: description: A summary of the interaction with the campaign. properties: action: description: "One of the following actions: 'open', 'click', or 'bounce'" title: Action type: string ip: description: The IP address recorded for the action. title: IP type: string timestamp: description: The date and time recorded for the action in ISO 8601 format. format: date-time title: Timestamp type: string type: description: "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'." title: Type type: string url: description: If the action is a 'click', the URL on which the member clicked. title: URL type: string title: Member Activity type: object title: Member Activity type: array campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The unique id for the 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 title: Email Activity type: object application/problem+json: schema: description: A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array activity: description: An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign. items: description: A summary of the interaction with the campaign. properties: action: description: "One of the following actions: 'open', 'click', or 'bounce'" title: Action type: string ip: description: The IP address recorded for the action. title: IP type: string timestamp: description: The date and time recorded for the action in ISO 8601 format. format: date-time title: Timestamp type: string type: description: "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'." title: Type type: string url: description: If the action is a 'click', the URL on which the member clicked. title: URL type: string title: Member Activity type: object title: Member Activity type: array campaign_id: description: The unique id for the campaign. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The unique id for the 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 title: Email Activity 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 email activity tags: - reports x-custom-config: methodNameCamel: getEmailActivityForSubscriber methodNameSnake: get_email_activity_for_subscriber "/reports/{campaign_id}/locations": get: deprecated: false description: Get top open locations for a specific campaign. operationId: getReportsIdLocations 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 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: Top open locations 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 campaign id. readOnly: true title: Campaign ID type: string locations: description: An array of objects, each representing a top location for opens. items: properties: country_code: description: The ISO 3166 2 digit country code. readOnly: true title: Country Code type: string opens: description: The number of unique campaign opens for a region. readOnly: true title: Opens type: integer region: description: An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region. readOnly: true title: Region type: string region_name: description: The name of the region, if we have one. For blank "region" values, this will be "Rest of Country". readOnly: true title: Region Name type: string type: object title: Lists type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Open Locations type: object application/problem+json: schema: description: Top open locations 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 campaign id. readOnly: true title: Campaign ID type: string locations: description: An array of objects, each representing a top location for opens. items: properties: country_code: description: The ISO 3166 2 digit country code. readOnly: true title: Country Code type: string opens: description: The number of unique campaign opens for a region. readOnly: true title: Opens type: integer region: description: An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region. readOnly: true title: Region type: string region_name: description: The name of the region, if we have one. For blank "region" values, this will be "Rest of Country". readOnly: true title: Region Name type: string type: object title: Lists type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Open Locations 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 top open activities tags: - reports x-custom-config: methodNameCamel: getLocationsForCampaign methodNameSnake: get_locations_for_campaign "/reports/{campaign_id}/open-details": get: deprecated: false description: Get detailed information about any campaign emails that were opened by a list member. operationId: getReportsIdOpenDetails 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 unique id for the campaign. in: path name: campaign_id required: true schema: type: string x-title: Campaign ID - description: "Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." example: 2016-04-12 12:00:00 in: query name: since required: false schema: type: string x-title: Campaign opens since - description: Returns open reports sorted by the specified field. in: query name: sort_field required: false schema: enum: - opens_count 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: A detailed report of any campaign emails that were opened by a list member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id. readOnly: true title: Campaign ID type: string members: description: An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event. items: description: A list of a member's opens activity in 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 contact_status: description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true title: Member Status type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The unique id for the 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object opens: description: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event. items: description: A summary of the interaction with the campaign. properties: timestamp: description: The date and time recorded for the action in ISO 8601 format. format: date-time title: Timestamp type: string title: Member Activity type: object title: Time series data of opens activity type: array opens_count: description: The total number of times the this campaign was opened by the list member. readOnly: true title: Opens count type: integer vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Open Activity type: object title: Open Reports type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer total_opens: description: The total number of opens matching the query regardless of pagination. title: Total opens type: integer title: Open Detail Report type: object application/problem+json: schema: description: A detailed report of any campaign emails that were opened by a list member. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 campaign id. readOnly: true title: Campaign ID type: string members: description: An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event. items: description: A list of a member's opens activity in 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 contact_status: description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true title: Member Status type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The unique id for the 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object opens: description: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event. items: description: A summary of the interaction with the campaign. properties: timestamp: description: The date and time recorded for the action in ISO 8601 format. format: date-time title: Timestamp type: string title: Member Activity type: object title: Time series data of opens activity type: array opens_count: description: The total number of times the this campaign was opened by the list member. readOnly: true title: Opens count type: integer vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Open Activity type: object title: Open Reports type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer total_opens: description: The total number of opens matching the query regardless of pagination. title: Total opens type: integer title: Open Detail Report 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 open details tags: - reports x-custom-config: methodNameCamel: getCampaignOpenDetails methodNameSnake: get_campaign_open_details "/reports/{campaign_id}/open-details/{subscriber_hash}": get: deprecated: false description: Get information about a specific subscriber who opened a campaign. operationId: getReportsIdOpenDetailsIdMembersId 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 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 list of a member's opens activity in 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 contact_status: description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true title: Member Status type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The unique id for the 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object opens: description: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event. items: description: A summary of the interaction with the campaign. properties: timestamp: description: The date and time recorded for the action in ISO 8601 format. format: date-time title: Timestamp type: string title: Member Activity type: object title: Time series data of opens activity type: array opens_count: description: The total number of times the this campaign was opened by the list member. readOnly: true title: Opens count type: integer vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Open Activity type: object application/problem+json: schema: description: A list of a member's opens activity in 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 contact_status: description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true title: Member Status type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The unique id for the 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object opens: description: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event. items: description: A summary of the interaction with the campaign. properties: timestamp: description: The date and time recorded for the action in ISO 8601 format. format: date-time title: Timestamp type: string title: Member Activity type: object title: Time series data of opens activity type: array opens_count: description: The total number of times the this campaign was opened by the list member. readOnly: true title: Opens count type: integer vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Open Activity 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 opened campaign subscriber tags: - reports x-custom-config: methodNameCamel: getSubscriberInfoForOpenedCampaign methodNameSnake: get_subscriber_info_for_opened_campaign "/reports/{campaign_id}/sent-to": get: deprecated: false description: Get information about campaign recipients. operationId: getReportsIdSentTo 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 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 list of subscribers who were sent 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 campaign id. readOnly: true title: Campaign ID type: string sent_to: description: An array of objects, each representing a campaign recipient. items: description: A subscriber's status 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 absplit_group: description: For A/B Split Campaigns, the group the member was apart of. enum: - a - b - winner title: A/B Split Group type: string campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_open: description: The date and time of the last open for this member in ISO 8601 format. format: date-time title: Last Open type: string list_id: description: The unique list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object open_count: description: The number of times a campaign was opened by this member. title: Open Count type: integer status: description: The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/). enum: - sent - hard - soft title: Delivery Status type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Sent To type: object title: Sent To type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Sent-To type: object application/problem+json: schema: description: A list of subscribers who were sent 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 campaign id. readOnly: true title: Campaign ID type: string sent_to: description: An array of objects, each representing a campaign recipient. items: description: A subscriber's status 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 absplit_group: description: For A/B Split Campaigns, the group the member was apart of. enum: - a - b - winner title: A/B Split Group type: string campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_open: description: The date and time of the last open for this member in ISO 8601 format. format: date-time title: Last Open type: string list_id: description: The unique list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object open_count: description: The number of times a campaign was opened by this member. title: Open Count type: integer status: description: The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/). enum: - sent - hard - soft title: Delivery Status type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Sent To type: object title: Sent To type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Sent-To 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 recipients tags: - reports x-custom-config: methodNameCamel: getCampaignRecipients methodNameSnake: get_campaign_recipients "/reports/{campaign_id}/sent-to/{subscriber_hash}": get: deprecated: false description: Get information about a specific campaign recipient. operationId: getReportsIdSentToId 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 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 subscriber's status 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 absplit_group: description: For A/B Split Campaigns, the group the member was apart of. enum: - a - b - winner title: A/B Split Group type: string campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_open: description: The date and time of the last open for this member in ISO 8601 format. format: date-time title: Last Open type: string list_id: description: The unique list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object open_count: description: The number of times a campaign was opened by this member. title: Open Count type: integer status: description: The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/). enum: - sent - hard - soft title: Delivery Status type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Sent To type: object application/problem+json: schema: description: A subscriber's status 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 absplit_group: description: For A/B Split Campaigns, the group the member was apart of. enum: - a - b - winner title: A/B Split Group type: string campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email Hash type: string gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_open: description: The date and time of the last open for this member in ISO 8601 format. format: date-time title: Last Open type: string list_id: description: The unique list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object open_count: description: The number of times a campaign was opened by this member. title: Open Count type: integer status: description: The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/). enum: - sent - hard - soft title: Delivery Status type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Sent To 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 recipient info tags: - reports x-custom-config: methodNameCamel: getCampaignRecipient methodNameSnake: get_campaign_recipient "/reports/{campaign_id}/sub-reports": get: deprecated: false description: Get a list of reports with child campaigns for a specific parent campaign. operationId: getReportsIdSubReportsId 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 list of reports containing child campaigns 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: Unique identifier of the parent campaign title: Campaign ID type: string reports: description: An array of objects, each representing a report resource. items: description: Report details about a sent 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 ab_split: description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Campaign A. properties: abuse_reports: description: Abuse reports for Campaign A. title: Abuse Reports type: integer bounces: description: Bounces for Campaign A. title: Bounces type: integer forwards: description: Forwards for Campaign A. title: Forwards type: integer forwards_opens: description: Opens from forwards for Campaign A. title: Forward Opens type: integer last_open: description: The last open for Campaign A. title: Last Open type: string opens: description: Opens for Campaign A. title: Opens type: integer recipient_clicks: description: Recipient Clicks for Campaign A. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign A. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign A. title: Unsubscribes type: integer title: Campaign A type: object b: description: Stats for Campaign B. properties: abuse_reports: description: Abuse reports for Campaign B. title: Abuse Reports type: integer bounces: description: Bounces for Campaign B. title: Bounces type: integer forwards: description: Forwards for Campaign B. title: Forwards type: integer forwards_opens: description: Opens for forwards from Campaign B. title: Forward Opens type: integer last_open: description: The last open for Campaign B. title: Last Open type: string opens: description: Opens for Campaign B. title: Opens type: integer recipient_clicks: description: Recipients clicks for Campaign B. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign B. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign B. title: Unsubscribes type: integer title: Campaign B type: object title: A/B Split Stats type: object abuse_reports: description: The number of abuse reports generated for this campaign. title: Abuse Reports type: integer bounces: description: An object describing the bounce summary for the campaign. properties: hard_bounces: description: The total number of hard bounced email addresses. title: Hard Bounces type: integer soft_bounces: description: The total number of soft bounced email addresses. title: Soft Bounces type: integer syntax_errors: description: The total number of addresses that were syntax-related bounces. title: Syntax Errors type: integer title: Bounces type: object campaign_title: description: The title of the campaign. readOnly: true title: Campaign Title type: string clicks: description: An object describing the click activity for the campaign. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. title: Click Rate type: number clicks_total: description: The total number of clicks for the campaign. title: Total Clicks type: integer last_click: description: The date and time of the last recorded click for the campaign in ISO 8601 format. format: date-time title: Last Click type: string unique_clicks: description: The total number of unique clicks for links across a campaign. title: Unique Clicks type: integer unique_subscriber_clicks: description: The total number of subscribers who clicked on a campaign. title: Unique Subscriber Clicks type: integer title: Clicks type: object 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 ecommerce: description: E-Commerce stats for a campaign. properties: currency_code: example: USD readOnly: true title: Three letter currency code for this user type: string 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 emails_sent: description: The total number of emails sent for this campaign. title: Emails Sent type: integer facebook_likes: description: An object describing campaign engagement on Facebook. properties: facebook_likes: description: The number of Facebook likes for the campaign. title: Facebook Likes type: integer recipient_likes: description: The number of recipients who liked the campaign on Facebook. title: Recipient Likes type: integer unique_likes: description: The number of unique likes. title: Unique Likes type: integer title: Facebook Likes type: object forwards: description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: description: How many times the campaign has been forwarded. title: Total Forwards type: integer forwards_opens: description: How many times the forwarded campaign has been opened. title: Forward Opens type: integer title: Forwards type: object id: description: A string that uniquely identifies this campaign. title: Campaign ID type: string industry_stats: description: The average campaign statistics for your industry. properties: abuse_rate: description: The industry abuse rate. title: Abuse Rate type: number bounce_rate: description: The industry bounce rate. title: Bounce Rate type: number click_rate: description: The industry click rate. title: Click Rate type: number open_rate: description: The industry open rate. title: Open Rate type: number type: description: "The type of business industry associated with your account. For example: retail, education, etc." title: Industry Type type: string unopen_rate: description: The industry unopened rate. title: Unopened Rate type: number unsub_rate: description: The industry unsubscribe rate. title: Unsubscribe Rate type: number title: Industry Stats type: object list_id: description: The unique list id. 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 list_name: description: The name of the list. readOnly: true title: List Name type: string list_stats: description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Click Rate type: number open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Open Rate type: number sub_rate: description: The average number of subscriptions per month for the list. readOnly: true title: Average Subscription Rate type: number unsub_rate: description: The average number of unsubscriptions per month for the list. readOnly: true title: Average Unsubscription Rate type: number title: List Stats type: object opens: description: An object describing the open activity for the campaign. properties: last_open: description: The date and time of the last recorded open in ISO 8601 format. format: date-time title: Last Open type: string open_rate: description: The number of unique opens divided by the total number of successful deliveries. title: Open Rate type: number opens_total: description: The total number of opens for a campaign. title: Total Opens type: integer unique_opens: description: The total number of unique opens. title: Unique Opens type: integer title: Opens type: object preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string rss_last_send: description: For RSS campaigns, the date and time of the last send in ISO 8601 format. format: date-time readOnly: true title: RSS Last Send type: string 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 share_report: description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_password: description: If password protected, the password for the VIP report. readOnly: true title: Report Password type: string share_url: description: The URL for the VIP report. readOnly: true title: Report URL type: string title: Share Report type: object subject_line: description: The subject line for the campaign. readOnly: true title: Campaign Subject Line type: string timeseries: description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: properties: emails_sent: description: The number of emails sent in the timeseries. title: Emails Sent type: integer recipients_clicks: description: The number of clicks in the timeseries. title: Recipient Clicks type: integer timestamp: description: The date and time for the series in ISO 8601 format. format: date-time title: Timestamp type: string unique_opens: description: The number of unique opens in the timeseries. title: Unique Opens type: integer type: object title: Timeseries type: array timewarp: description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: properties: bounces: description: The number of bounces. title: Bounces type: integer clicks: description: The number of clicks. title: Clicks type: integer gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_click: description: The date and time of the last click in ISO 8601 format. format: date-time title: Last Click type: string last_open: description: The date and time of the last open in ISO 8601 format. format: date-time title: Last Open type: string opens: description: The number of opens. title: Opens type: integer unique_clicks: description: The number of unique clicks. title: Unique Clicks type: integer unique_opens: description: The number of unique opens. title: Unique Opens type: integer type: object title: Timewarp Stats type: array type: description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). title: Campaign Type type: string unsubscribed: description: The total number of unsubscribed members for this campaign. readOnly: true title: Unsubscribe Count type: integer title: Campaign Report type: object title: Reports 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 Sub-Reports type: object application/problem+json: schema: description: A list of reports containing child campaigns 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: Unique identifier of the parent campaign title: Campaign ID type: string reports: description: An array of objects, each representing a report resource. items: description: Report details about a sent 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 ab_split: description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: description: Stats for Campaign A. properties: abuse_reports: description: Abuse reports for Campaign A. title: Abuse Reports type: integer bounces: description: Bounces for Campaign A. title: Bounces type: integer forwards: description: Forwards for Campaign A. title: Forwards type: integer forwards_opens: description: Opens from forwards for Campaign A. title: Forward Opens type: integer last_open: description: The last open for Campaign A. title: Last Open type: string opens: description: Opens for Campaign A. title: Opens type: integer recipient_clicks: description: Recipient Clicks for Campaign A. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign A. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign A. title: Unsubscribes type: integer title: Campaign A type: object b: description: Stats for Campaign B. properties: abuse_reports: description: Abuse reports for Campaign B. title: Abuse Reports type: integer bounces: description: Bounces for Campaign B. title: Bounces type: integer forwards: description: Forwards for Campaign B. title: Forwards type: integer forwards_opens: description: Opens for forwards from Campaign B. title: Forward Opens type: integer last_open: description: The last open for Campaign B. title: Last Open type: string opens: description: Opens for Campaign B. title: Opens type: integer recipient_clicks: description: Recipients clicks for Campaign B. title: Recipient Clicks type: integer unique_opens: description: Unique opens for Campaign B. title: Unique Opens type: integer unsubs: description: Unsubscribes for Campaign B. title: Unsubscribes type: integer title: Campaign B type: object title: A/B Split Stats type: object abuse_reports: description: The number of abuse reports generated for this campaign. title: Abuse Reports type: integer bounces: description: An object describing the bounce summary for the campaign. properties: hard_bounces: description: The total number of hard bounced email addresses. title: Hard Bounces type: integer soft_bounces: description: The total number of soft bounced email addresses. title: Soft Bounces type: integer syntax_errors: description: The total number of addresses that were syntax-related bounces. title: Syntax Errors type: integer title: Bounces type: object campaign_title: description: The title of the campaign. readOnly: true title: Campaign Title type: string clicks: description: An object describing the click activity for the campaign. properties: click_rate: description: The number of unique clicks divided by the total number of successful deliveries. title: Click Rate type: number clicks_total: description: The total number of clicks for the campaign. title: Total Clicks type: integer last_click: description: The date and time of the last recorded click for the campaign in ISO 8601 format. format: date-time title: Last Click type: string unique_clicks: description: The total number of unique clicks for links across a campaign. title: Unique Clicks type: integer unique_subscriber_clicks: description: The total number of subscribers who clicked on a campaign. title: Unique Subscriber Clicks type: integer title: Clicks type: object 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 ecommerce: description: E-Commerce stats for a campaign. properties: currency_code: example: USD readOnly: true title: Three letter currency code for this user type: string 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 emails_sent: description: The total number of emails sent for this campaign. title: Emails Sent type: integer facebook_likes: description: An object describing campaign engagement on Facebook. properties: facebook_likes: description: The number of Facebook likes for the campaign. title: Facebook Likes type: integer recipient_likes: description: The number of recipients who liked the campaign on Facebook. title: Recipient Likes type: integer unique_likes: description: The number of unique likes. title: Unique Likes type: integer title: Facebook Likes type: object forwards: description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: description: How many times the campaign has been forwarded. title: Total Forwards type: integer forwards_opens: description: How many times the forwarded campaign has been opened. title: Forward Opens type: integer title: Forwards type: object id: description: A string that uniquely identifies this campaign. title: Campaign ID type: string industry_stats: description: The average campaign statistics for your industry. properties: abuse_rate: description: The industry abuse rate. title: Abuse Rate type: number bounce_rate: description: The industry bounce rate. title: Bounce Rate type: number click_rate: description: The industry click rate. title: Click Rate type: number open_rate: description: The industry open rate. title: Open Rate type: number type: description: "The type of business industry associated with your account. For example: retail, education, etc." title: Industry Type type: string unopen_rate: description: The industry unopened rate. title: Unopened Rate type: number unsub_rate: description: The industry unsubscribe rate. title: Unsubscribe Rate type: number title: Industry Stats type: object list_id: description: The unique list id. 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 list_name: description: The name of the list. readOnly: true title: List Name type: string list_stats: description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: click_rate: description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Click Rate type: number open_rate: description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true title: Open Rate type: number sub_rate: description: The average number of subscriptions per month for the list. readOnly: true title: Average Subscription Rate type: number unsub_rate: description: The average number of unsubscriptions per month for the list. readOnly: true title: Average Unsubscription Rate type: number title: List Stats type: object opens: description: An object describing the open activity for the campaign. properties: last_open: description: The date and time of the last recorded open in ISO 8601 format. format: date-time title: Last Open type: string open_rate: description: The number of unique opens divided by the total number of successful deliveries. title: Open Rate type: number opens_total: description: The total number of opens for a campaign. title: Total Opens type: integer unique_opens: description: The total number of unique opens. title: Unique Opens type: integer title: Opens type: object preview_text: description: The preview text for the campaign. title: Campaign Preview Text type: string rss_last_send: description: For RSS campaigns, the date and time of the last send in ISO 8601 format. format: date-time readOnly: true title: RSS Last Send type: string 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 share_report: description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_password: description: If password protected, the password for the VIP report. readOnly: true title: Report Password type: string share_url: description: The URL for the VIP report. readOnly: true title: Report URL type: string title: Share Report type: object subject_line: description: The subject line for the campaign. readOnly: true title: Campaign Subject Line type: string timeseries: description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: properties: emails_sent: description: The number of emails sent in the timeseries. title: Emails Sent type: integer recipients_clicks: description: The number of clicks in the timeseries. title: Recipient Clicks type: integer timestamp: description: The date and time for the series in ISO 8601 format. format: date-time title: Timestamp type: string unique_opens: description: The number of unique opens in the timeseries. title: Unique Opens type: integer type: object title: Timeseries type: array timewarp: description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: properties: bounces: description: The number of bounces. title: Bounces type: integer clicks: description: The number of clicks. title: Clicks type: integer gmt_offset: description: For campaigns sent with timewarp, the time zone group the member is apart of. title: GMT Offset type: integer last_click: description: The date and time of the last click in ISO 8601 format. format: date-time title: Last Click type: string last_open: description: The date and time of the last open in ISO 8601 format. format: date-time title: Last Open type: string opens: description: The number of opens. title: Opens type: integer unique_clicks: description: The number of unique clicks. title: Unique Clicks type: integer unique_opens: description: The number of unique opens. title: Unique Opens type: integer type: object title: Timewarp Stats type: array type: description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). title: Campaign Type type: string unsubscribed: description: The total number of unsubscribed members for this campaign. readOnly: true title: Unsubscribe Count type: integer title: Campaign Report type: object title: Reports 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 Sub-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 child campaign reports tags: - reports x-custom-config: methodNameCamel: getSubReportsForCampaign methodNameSnake: get_sub_reports_for_campaign "/reports/{campaign_id}/unsubscribed": get: deprecated: false description: Get information about members who have unsubscribed from a specific campaign. operationId: getReportsIdUnsubscribed 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 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 list of members who have unsubscribed 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer unsubscribes: description: An array of objects, each representing a member who unsubscribed from a campaign. items: description: A member who unsubscribed 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object reason: description: If available, the reason listed by the member for unsubscribing. readOnly: true title: Unsubscribe Reason type: string timestamp: description: The date and time the member opted-out in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Unsubscribes type: object title: Lists type: array title: Unsubscribes type: object application/problem+json: schema: description: A list of members who have unsubscribed 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer unsubscribes: description: An array of objects, each representing a member who unsubscribed from a campaign. items: description: A member who unsubscribed 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object reason: description: If available, the reason listed by the member for unsubscribing. readOnly: true title: Unsubscribe Reason type: string timestamp: description: The date and time the member opted-out in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Unsubscribes type: object title: Lists type: array title: Unsubscribes 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 unsubscribed members tags: - reports x-custom-config: methodNameCamel: getUnsubscribedListForCampaign methodNameSnake: get_unsubscribed_list_for_campaign "/reports/{campaign_id}/unsubscribed/{subscriber_hash}": get: deprecated: false description: Get information about a specific list member who unsubscribed from a campaign. operationId: getReportsIdUnsubscribedId 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 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 member who unsubscribed 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object reason: description: If available, the reason listed by the member for unsubscribing. readOnly: true title: Unsubscribe Reason type: string timestamp: description: The date and time the member opted-out in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Unsubscribes type: object application/problem+json: schema: description: A member who unsubscribed 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 campaign_id: description: The campaign id. readOnly: true title: Campaign ID type: string email_address: description: Email address for a subscriber. readOnly: true title: Email Address type: string email_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: The list id. 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 merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object reason: description: If available, the reason listed by the member for unsubscribing. readOnly: true title: Unsubscribe Reason type: string timestamp: description: The date and time the member opted-out in ISO 8601 format. format: date-time readOnly: true title: Timestamp type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." readOnly: true title: VIP type: boolean title: Unsubscribes 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 unsubscribed member tags: - reports x-custom-config: methodNameCamel: getUnsubscribedListMember methodNameSnake: get_unsubscribed_list_member /search-campaigns: get: deprecated: false description: Search all campaigns for the specified query terms. operationId: getSearchCampaigns 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 search query used to filter results. in: query name: query required: true schema: type: string x-title: Query responses: "200": content: application/json: schema: description: Campaigns and Snippets found for given search term. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array results: description: An array of matching campaigns and snippets. items: properties: campaign: 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 snippet: title: Matching snippet type: string type: object title: Results type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Campaigns type: object application/problem+json: schema: description: Campaigns and Snippets found for given search term. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array results: description: An array of matching campaigns and snippets. items: properties: campaign: 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 snippet: title: Matching snippet type: string type: object title: Results type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Campaigns 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: Search campaigns tags: - searchCampaigns x-custom-config: methodNameCamel: search methodNameSnake: search /search-members: get: deprecated: false description: Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. operationId: getSearchMembers 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 search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. in: query name: query required: true schema: type: string x-title: Query - description: The unique id for the list. in: query name: list_id required: false schema: type: string x-title: List ID responses: "200": content: application/json: schema: description: Members found for given search term properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array exact_matches: description: Exact matches of the provided search query. properties: members: description: An array of objects, each representing a specific list member. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object title: Members type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Exact Matches type: object full_search: description: Partial matches of the provided search query. properties: members: description: An array of objects, each representing a specific list member. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object title: Members type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Partial Matches type: object title: Members type: object application/problem+json: schema: description: Members found for given search term properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array exact_matches: description: Exact matches of the provided search query. properties: members: description: An array of objects, each representing a specific list member. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object title: Members type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Exact Matches type: object full_search: description: Partial matches of the provided search query. properties: members: description: An array of objects, each representing a specific list member. items: description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array consents_to_one_to_one_messaging: description: Indicates whether a contact consents to 1:1 messaging. readOnly: true title: Messaging Consent type: boolean contact_id: description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true title: Contact ID type: string email_address: description: Email address for a subscriber. title: Email Address type: string email_client: description: The list member's email client. readOnly: true title: Email Client type: string email_type: description: Type of email this member asked to get ('html' or 'text'). title: Email Type type: string full_name: description: The contact's full name. readOnly: true title: Full Name type: string id: description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true title: Email ID type: string interests: additionalProperties: description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. title: Interest Value type: boolean description: The key of this object's properties is the ID of the interest in question. title: Subscriber Interests type: object ip_opt: description: The IP address the subscriber used to confirm their opt-in status. readOnly: true title: Opt-in IP type: string ip_signup: description: IP address the subscriber signed up from. readOnly: true title: Signup IP type: string language: description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). title: Language type: string last_changed: description: The date and time the member's info was last changed in ISO 8601 format. format: date-time readOnly: true title: Last Changed Date type: string last_note: description: The most recent Note added about this member. properties: created_at: description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true title: Created Time type: string created_by: description: The author of the note. readOnly: true title: Author type: string note: description: The content of the note. readOnly: true title: Note type: string note_id: description: The note id. readOnly: true title: Note ID type: integer readOnly: true title: Notes type: object list_id: description: The list id. readOnly: true title: List ID type: string location: description: Subscriber location information. properties: country_code: description: The unique code for the location country. readOnly: true title: Country Code type: string dstoff: description: The offset for timezones where daylight saving time is observed. readOnly: true title: DST Offset type: integer gmtoff: description: The time difference in hours from GMT. readOnly: true title: GMT Offset type: integer latitude: description: The location latitude. title: Latitude type: number longitude: description: The location longitude. title: Longitude type: number region: description: The region for the location. readOnly: true title: Region type: string timezone: description: The timezone for the location. readOnly: true title: Timezone type: string title: Location type: object marketing_permissions: description: The marketing permissions for the subscriber. items: description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: enabled: description: If the subscriber has opted-in to the marketing permission. title: Enabled type: boolean marketing_permission_id: description: The id for the marketing permission on the list title: Marketing Permission ID type: string text: description: The text of the marketing permission. title: Marketing Permission Text type: string title: Marketing Permission type: object title: Marketing Permissions type: array member_rating: description: Star rating for this member, between 1 and 5. readOnly: true title: Member Rating type: integer merge_fields: additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. title: Merge Fields type: object source: description: The source from which the subscriber was added to this list. readOnly: true title: Subscriber Source type: string stats: description: Open and click rates for this subscriber. properties: avg_click_rate: description: A subscriber's average clickthrough rate. readOnly: true title: Average Click Rate type: number avg_open_rate: description: A subscriber's average open rate. readOnly: true title: Average Open Rate type: number ecommerce_data: description: Ecommerce stats for the list member if the list is attached to a store. properties: currency_code: description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD readOnly: true title: Currency type: string number_of_orders: description: The total number of orders placed by the list member. readOnly: true title: Total Number of Orders type: number total_revenue: description: The total revenue the list member has brought in. readOnly: true title: Total Revenue type: number readOnly: true title: Ecommerce Stats type: object readOnly: true title: Subscriber Stats type: object status: description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived title: Status type: string tags: description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). items: properties: id: description: The tag id. readOnly: true title: Tag ID type: integer name: description: The name of the tag readOnly: true title: Tag Name type: string type: object readOnly: false title: Tags type: array tags_count: description: The number of tags applied to this member. readOnly: true title: Tags Count type: integer timestamp_opt: description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time readOnly: true title: Opt-in Timestamp type: string timestamp_signup: description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true title: Signup Timestamp type: string unique_email_id: description: An identifier for the address across all of Mailchimp. readOnly: true title: Unique Email ID type: string unsubscribe_reason: description: A subscriber's reason for unsubscribing. title: Unsubscribe Reason type: string vip: description: "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber." title: VIP type: boolean web_id: description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true title: Member Web ID type: integer title: List Members type: object title: Members type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Partial Matches type: object title: Members 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: Search members tags: - searchMembers x-custom-config: methodNameCamel: search methodNameSnake: search /template-folders: get: deprecated: false description: Get all folders used to organize templates. operationId: getTemplateFolders 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 template 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 template folders. items: description: A folder used to organize templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 templates in the folder. readOnly: true title: Template Count type: integer id: description: A string that uniquely identifies this template folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Template Folder type: object title: Template 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: Template Folders type: object application/problem+json: schema: description: A list of template 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 template folders. items: description: A folder used to organize templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 templates in the folder. readOnly: true title: Template Count type: integer id: description: A string that uniquely identifies this template folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Template Folder type: object title: Template 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: Template 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 template folders tags: - templateFolders x-custom-config: methodNameCamel: list methodNameSnake: list post: deprecated: false description: Create a new template folder. operationId: postTemplateFolders requestBody: $ref: "#/components/requestBodies/postTemplateFoldersBody" responses: "200": content: application/json: schema: description: A folder used to organize templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 templates in the folder. readOnly: true title: Template Count type: integer id: description: A string that uniquely identifies this template folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Template Folder type: object application/problem+json: schema: description: A folder used to organize templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 templates in the folder. readOnly: true title: Template Count type: integer id: description: A string that uniquely identifies this template folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Template 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 template folder tags: - templateFolders x-custom-config: methodNameCamel: create methodNameSnake: create "/template-folders/{folder_id}": delete: deprecated: false description: Delete a specific template folder, and mark all the templates in the folder as 'unfiled'. operationId: deleteTemplateFoldersId parameters: - description: The unique id for the template 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 template folder tags: - templateFolders x-custom-config: methodNameCamel: remove methodNameSnake: remove get: deprecated: false description: Get information about a specific folder used to organize templates. operationId: getTemplateFoldersId 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 template folder. in: path name: folder_id required: true schema: type: string responses: "200": content: application/json: schema: description: A folder used to organize templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 templates in the folder. readOnly: true title: Template Count type: integer id: description: A string that uniquely identifies this template folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Template Folder type: object application/problem+json: schema: description: A folder used to organize templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 templates in the folder. readOnly: true title: Template Count type: integer id: description: A string that uniquely identifies this template folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Template 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 template folder tags: - templateFolders x-custom-config: methodNameCamel: get methodNameSnake: get patch: deprecated: false description: Update a specific folder used to organize templates. operationId: patchTemplateFoldersId parameters: - description: The unique id for the template folder. in: path name: folder_id required: true schema: type: string requestBody: $ref: "#/components/requestBodies/postTemplateFoldersBody" responses: "200": content: application/json: schema: description: A folder used to organize templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 templates in the folder. readOnly: true title: Template Count type: integer id: description: A string that uniquely identifies this template folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Template Folder type: object application/problem+json: schema: description: A folder used to organize templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema 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 templates in the folder. readOnly: true title: Template Count type: integer id: description: A string that uniquely identifies this template folder. readOnly: true title: Folder Id type: string name: description: The name of the folder. title: Folder Name type: string title: Template 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 template folder tags: - templateFolders x-custom-config: methodNameCamel: update methodNameSnake: update /templates: get: deprecated: false description: Get a list of an account's available templates. operationId: getTemplates 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 Mailchimp account user who created the template. in: query name: created_by required: false schema: type: string x-title: Created By - description: "Restrict the response to templates created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: since_date_created required: false schema: type: string x-title: Since Date Created - description: "Restrict the response to templates created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." in: query name: before_date_created required: false schema: type: string x-title: Before Date Created - description: Limit results based on template type. in: query name: type required: false schema: type: string x-title: Template Type - description: Limit results based on category. in: query name: category required: false schema: type: string x-title: Category - description: The unique folder id. in: query name: folder_id required: false schema: type: string x-title: Folder ID - description: Returns user templates sorted by the specified field. in: query name: sort_field required: false schema: enum: - date_created - date_edited - name type: string x-title: Sort By Field - description: Limit results based on how the template's content is put together. Only templates of type `user` can be filtered by `content_type`. If you want to retrieve saved templates created with the legacy email editor, then filter `content_type` to `template`. If you'd rather pull your saved templates for the new editor, filter to `multichannel`. For code your own templates, filter to `html`. in: query name: content_type required: false schema: enum: - html - template - multichannel type: string x-title: Content Type - 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: A list an account's available templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array templates: description: All of an account's saved or custom templates. items: description: Information about a specific template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array active: description: User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true title: Active type: boolean category: description: If available, the category the template is listed in. readOnly: true title: Template Category type: string content_type: description: How the template's content is put together. enum: - template - multichannel - html readOnly: true title: Content Type type: string created_by: description: The login name for template's creator. readOnly: true title: Created By type: string date_created: description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string date_edited: description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true title: Date Edited type: string drag_and_drop: description: Whether the template uses the drag and drop editor. readOnly: true title: Drag and Drop type: boolean edited_by: description: The login name who last edited the template. readOnly: true title: Edited By type: string folder_id: description: The id of the folder the template is currently in. title: Folder ID type: string id: description: The individual id for the template. readOnly: true title: Template ID type: integer name: description: The name of the template. title: Template Name type: string responsive: description: Whether the template contains media queries to make it responsive. readOnly: true title: Responsive type: boolean share_url: description: The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true title: Share URL type: string thumbnail: description: If available, the URL for a thumbnail of the template. readOnly: true title: Template Thumbnail type: string type: description: The type of template (user, base, or gallery). readOnly: true title: Template Type type: string title: Template Instance type: object title: User Templates type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Templates type: object application/problem+json: schema: description: A list an account's available templates. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array templates: description: All of an account's saved or custom templates. items: description: Information about a specific template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array active: description: User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true title: Active type: boolean category: description: If available, the category the template is listed in. readOnly: true title: Template Category type: string content_type: description: How the template's content is put together. enum: - template - multichannel - html readOnly: true title: Content Type type: string created_by: description: The login name for template's creator. readOnly: true title: Created By type: string date_created: description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string date_edited: description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true title: Date Edited type: string drag_and_drop: description: Whether the template uses the drag and drop editor. readOnly: true title: Drag and Drop type: boolean edited_by: description: The login name who last edited the template. readOnly: true title: Edited By type: string folder_id: description: The id of the folder the template is currently in. title: Folder ID type: string id: description: The individual id for the template. readOnly: true title: Template ID type: integer name: description: The name of the template. title: Template Name type: string responsive: description: Whether the template contains media queries to make it responsive. readOnly: true title: Responsive type: boolean share_url: description: The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true title: Share URL type: string thumbnail: description: If available, the URL for a thumbnail of the template. readOnly: true title: Template Thumbnail type: string type: description: The type of template (user, base, or gallery). readOnly: true title: Template Type type: string title: Template Instance type: object title: User Templates type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Templates 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 templates tags: - templates x-custom-config: methodNameCamel: list methodNameSnake: list post: deprecated: false description: Create a new template for the account. Only Classic templates are supported. operationId: postTemplates requestBody: $ref: "#/components/requestBodies/postTemplatesBody" responses: "200": content: application/json: schema: description: Information about a specific template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array active: description: User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true title: Active type: boolean category: description: If available, the category the template is listed in. readOnly: true title: Template Category type: string content_type: description: How the template's content is put together. enum: - template - multichannel - html readOnly: true title: Content Type type: string created_by: description: The login name for template's creator. readOnly: true title: Created By type: string date_created: description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string date_edited: description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true title: Date Edited type: string drag_and_drop: description: Whether the template uses the drag and drop editor. readOnly: true title: Drag and Drop type: boolean edited_by: description: The login name who last edited the template. readOnly: true title: Edited By type: string folder_id: description: The id of the folder the template is currently in. title: Folder ID type: string id: description: The individual id for the template. readOnly: true title: Template ID type: integer name: description: The name of the template. title: Template Name type: string responsive: description: Whether the template contains media queries to make it responsive. readOnly: true title: Responsive type: boolean share_url: description: The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true title: Share URL type: string thumbnail: description: If available, the URL for a thumbnail of the template. readOnly: true title: Template Thumbnail type: string type: description: The type of template (user, base, or gallery). readOnly: true title: Template Type type: string title: Template Instance type: object application/problem+json: schema: description: Information about a specific template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array active: description: User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true title: Active type: boolean category: description: If available, the category the template is listed in. readOnly: true title: Template Category type: string content_type: description: How the template's content is put together. enum: - template - multichannel - html readOnly: true title: Content Type type: string created_by: description: The login name for template's creator. readOnly: true title: Created By type: string date_created: description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string date_edited: description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true title: Date Edited type: string drag_and_drop: description: Whether the template uses the drag and drop editor. readOnly: true title: Drag and Drop type: boolean edited_by: description: The login name who last edited the template. readOnly: true title: Edited By type: string folder_id: description: The id of the folder the template is currently in. title: Folder ID type: string id: description: The individual id for the template. readOnly: true title: Template ID type: integer name: description: The name of the template. title: Template Name type: string responsive: description: Whether the template contains media queries to make it responsive. readOnly: true title: Responsive type: boolean share_url: description: The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true title: Share URL type: string thumbnail: description: If available, the URL for a thumbnail of the template. readOnly: true title: Template Thumbnail type: string type: description: The type of template (user, base, or gallery). readOnly: true title: Template Type type: string title: Template Instance 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 template tags: - templates x-custom-config: methodNameCamel: create methodNameSnake: create "/templates/{template_id}": delete: deprecated: false description: Delete a specific template. operationId: deleteTemplatesId parameters: - description: The unique id for the template. in: path name: template_id required: true schema: type: string x-title: Template 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 template tags: - templates x-custom-config: methodNameCamel: deleteTemplate methodNameSnake: delete_template get: deprecated: false description: Get information about a specific template. operationId: getTemplatesId 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 template. in: path name: template_id required: true schema: type: string x-title: Template ID responses: "200": content: application/json: schema: description: Information about a specific template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array active: description: User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true title: Active type: boolean category: description: If available, the category the template is listed in. readOnly: true title: Template Category type: string content_type: description: How the template's content is put together. enum: - template - multichannel - html readOnly: true title: Content Type type: string created_by: description: The login name for template's creator. readOnly: true title: Created By type: string date_created: description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string date_edited: description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true title: Date Edited type: string drag_and_drop: description: Whether the template uses the drag and drop editor. readOnly: true title: Drag and Drop type: boolean edited_by: description: The login name who last edited the template. readOnly: true title: Edited By type: string folder_id: description: The id of the folder the template is currently in. title: Folder ID type: string id: description: The individual id for the template. readOnly: true title: Template ID type: integer name: description: The name of the template. title: Template Name type: string responsive: description: Whether the template contains media queries to make it responsive. readOnly: true title: Responsive type: boolean share_url: description: The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true title: Share URL type: string thumbnail: description: If available, the URL for a thumbnail of the template. readOnly: true title: Template Thumbnail type: string type: description: The type of template (user, base, or gallery). readOnly: true title: Template Type type: string title: Template Instance type: object application/problem+json: schema: description: Information about a specific template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array active: description: User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true title: Active type: boolean category: description: If available, the category the template is listed in. readOnly: true title: Template Category type: string content_type: description: How the template's content is put together. enum: - template - multichannel - html readOnly: true title: Content Type type: string created_by: description: The login name for template's creator. readOnly: true title: Created By type: string date_created: description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string date_edited: description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true title: Date Edited type: string drag_and_drop: description: Whether the template uses the drag and drop editor. readOnly: true title: Drag and Drop type: boolean edited_by: description: The login name who last edited the template. readOnly: true title: Edited By type: string folder_id: description: The id of the folder the template is currently in. title: Folder ID type: string id: description: The individual id for the template. readOnly: true title: Template ID type: integer name: description: The name of the template. title: Template Name type: string responsive: description: Whether the template contains media queries to make it responsive. readOnly: true title: Responsive type: boolean share_url: description: The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true title: Share URL type: string thumbnail: description: If available, the URL for a thumbnail of the template. readOnly: true title: Template Thumbnail type: string type: description: The type of template (user, base, or gallery). readOnly: true title: Template Type type: string title: Template Instance 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 template info tags: - templates x-custom-config: methodNameCamel: getTemplate methodNameSnake: get_template patch: deprecated: false description: Update the name, HTML, or `folder_id` of an existing template. operationId: patchTemplatesId parameters: - description: The unique id for the template. in: path name: template_id required: true schema: type: string x-title: Template ID requestBody: $ref: "#/components/requestBodies/postTemplatesBody" responses: "200": content: application/json: schema: description: Information about a specific template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array active: description: User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true title: Active type: boolean category: description: If available, the category the template is listed in. readOnly: true title: Template Category type: string content_type: description: How the template's content is put together. enum: - template - multichannel - html readOnly: true title: Content Type type: string created_by: description: The login name for template's creator. readOnly: true title: Created By type: string date_created: description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string date_edited: description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true title: Date Edited type: string drag_and_drop: description: Whether the template uses the drag and drop editor. readOnly: true title: Drag and Drop type: boolean edited_by: description: The login name who last edited the template. readOnly: true title: Edited By type: string folder_id: description: The id of the folder the template is currently in. title: Folder ID type: string id: description: The individual id for the template. readOnly: true title: Template ID type: integer name: description: The name of the template. title: Template Name type: string responsive: description: Whether the template contains media queries to make it responsive. readOnly: true title: Responsive type: boolean share_url: description: The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true title: Share URL type: string thumbnail: description: If available, the URL for a thumbnail of the template. readOnly: true title: Template Thumbnail type: string type: description: The type of template (user, base, or gallery). readOnly: true title: Template Type type: string title: Template Instance type: object application/problem+json: schema: description: Information about a specific template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array active: description: User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true title: Active type: boolean category: description: If available, the category the template is listed in. readOnly: true title: Template Category type: string content_type: description: How the template's content is put together. enum: - template - multichannel - html readOnly: true title: Content Type type: string created_by: description: The login name for template's creator. readOnly: true title: Created By type: string date_created: description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true title: Date Created type: string date_edited: description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true title: Date Edited type: string drag_and_drop: description: Whether the template uses the drag and drop editor. readOnly: true title: Drag and Drop type: boolean edited_by: description: The login name who last edited the template. readOnly: true title: Edited By type: string folder_id: description: The id of the folder the template is currently in. title: Folder ID type: string id: description: The individual id for the template. readOnly: true title: Template ID type: integer name: description: The name of the template. title: Template Name type: string responsive: description: Whether the template contains media queries to make it responsive. readOnly: true title: Responsive type: boolean share_url: description: The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true title: Share URL type: string thumbnail: description: If available, the URL for a thumbnail of the template. readOnly: true title: Template Thumbnail type: string type: description: The type of template (user, base, or gallery). readOnly: true title: Template Type type: string title: Template Instance 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 template tags: - templates x-custom-config: methodNameCamel: updateTemplate methodNameSnake: update_template "/templates/{template_id}/default-content": get: deprecated: false description: Get the sections that you can edit in a template, including each section's default content. operationId: getTemplatesIdDefaultContent 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 template. in: path name: template_id required: true schema: type: string x-title: Template ID responses: "200": content: application/json: schema: description: Default content for a template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array sections: additionalProperties: description: The default content for the sections that you can edit in the template. description: The sections that you can edit in the template, including each section's default content. title: Sections type: object title: Template Default Content type: object application/problem+json: schema: description: Default content for a template. properties: _links: description: A list of link types and descriptions for the API schema documents. items: description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: href: description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true title: Href type: string method: description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true title: Method type: string rel: description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true title: Rel type: string schema: description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true title: Schema type: string targetSchema: description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true title: Target Schema type: string title: Resource Link type: object readOnly: true title: Links type: array sections: additionalProperties: description: The default content for the sections that you can edit in the template. description: The sections that you can edit in the template, including each section's default content. title: Sections type: object title: Template Default 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: View default content tags: - templates x-custom-config: methodNameCamel: getDefaultContentForTemplate methodNameSnake: get_default_content_for_template /verified-domains: get: deprecated: false description: Get all of the sending domains on the account. operationId: getVerifiedDomains responses: "200": content: application/json: schema: description: The verified domains currently on the account. properties: domains: description: The domains on the account items: description: The verified domains currently on the account. properties: authenticated: description: Whether domain authentication is enabled for this domain. readOnly: true title: Authenticated type: boolean domain: description: The name of this domain. readOnly: true title: Domain Name type: string verification_email: description: The e-mail address receiving the two-factor challenge for this domain. readOnly: true title: Verification Email type: string verification_sent: description: The date/time that the two-factor challenge was sent to the verification email. format: date-time readOnly: true title: Verification Challenge Sent type: string verified: description: Whether the domain has been verified for sending. readOnly: true title: Verified type: boolean title: Verified Domains type: object readOnly: true title: Domains type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Verified Domains type: object application/problem+json: schema: description: The verified domains currently on the account. properties: domains: description: The domains on the account items: description: The verified domains currently on the account. properties: authenticated: description: Whether domain authentication is enabled for this domain. readOnly: true title: Authenticated type: boolean domain: description: The name of this domain. readOnly: true title: Domain Name type: string verification_email: description: The e-mail address receiving the two-factor challenge for this domain. readOnly: true title: Verification Email type: string verification_sent: description: The date/time that the two-factor challenge was sent to the verification email. format: date-time readOnly: true title: Verification Challenge Sent type: string verified: description: Whether the domain has been verified for sending. readOnly: true title: Verified type: boolean title: Verified Domains type: object readOnly: true title: Domains type: array total_items: description: The total number of items matching the query regardless of pagination. readOnly: true title: Item Count type: integer title: Verified Domains type: object description: The domains on the account. 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 sending domains tags: - verifiedDomains x-custom-config: methodNameCamel: getVerifiedDomainsAll methodNameSnake: get_verified_domains_all post: deprecated: false description: Add a domain to the account. operationId: createVerifiedDomain requestBody: content: application/json: schema: description: The verified domains currently on the account. properties: verification_email: description: The e-mail address at the domain you want to verify. This will receive a two-factor challenge to be used in the verify action. title: Verification Email type: string required: - verification_email title: Verified Domains type: object required: true responses: "200": content: application/json: schema: description: The verified domains currently on the account. properties: authenticated: description: Whether domain authentication is enabled for this domain. readOnly: true title: Authenticated type: boolean domain: description: The name of this domain. readOnly: true title: Domain Name type: string verification_email: description: The e-mail address receiving the two-factor challenge for this domain. readOnly: true title: Verification Email type: string verification_sent: description: The date/time that the two-factor challenge was sent to the verification email. format: date-time readOnly: true title: Verification Challenge Sent type: string verified: description: Whether the domain has been verified for sending. readOnly: true title: Verified type: boolean title: Verified Domains type: object application/problem+json: schema: description: The verified domains currently on the account. properties: authenticated: description: Whether domain authentication is enabled for this domain. readOnly: true title: Authenticated type: boolean domain: description: The name of this domain. readOnly: true title: Domain Name type: string verification_email: description: The e-mail address receiving the two-factor challenge for this domain. readOnly: true title: Verification Email type: string verification_sent: description: The date/time that the two-factor challenge was sent to the verification email. format: date-time readOnly: true title: Verification Challenge Sent type: string verified: description: Whether the domain has been verified for sending. readOnly: true title: Verified type: boolean title: Verified Domains type: object description: The newly-created domain. 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 domain to account tags: - verifiedDomains x-custom-config: methodNameCamel: createVerifiedDomain methodNameSnake: create_verified_domain "/verified-domains/{domain_name}": delete: deprecated: false description: Delete a verified domain from the account. operationId: deleteVerifiedDomain parameters: - description: The domain name. in: path name: domain_name required: true schema: type: string x-title: Domain Name 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 domain tags: - verifiedDomains x-custom-config: methodNameCamel: deleteDomain methodNameSnake: delete_domain get: deprecated: false description: Get the details for a single domain on the account. operationId: getVerifiedDomain parameters: - description: The domain name. in: path name: domain_name required: true schema: type: string x-title: Domain Name responses: "200": content: application/json: schema: description: The verified domains currently on the account. properties: authenticated: description: Whether domain authentication is enabled for this domain. readOnly: true title: Authenticated type: boolean domain: description: The name of this domain. readOnly: true title: Domain Name type: string verification_email: description: The e-mail address receiving the two-factor challenge for this domain. readOnly: true title: Verification Email type: string verification_sent: description: The date/time that the two-factor challenge was sent to the verification email. format: date-time readOnly: true title: Verification Challenge Sent type: string verified: description: Whether the domain has been verified for sending. readOnly: true title: Verified type: boolean title: Verified Domains type: object application/problem+json: schema: description: The verified domains currently on the account. properties: authenticated: description: Whether domain authentication is enabled for this domain. readOnly: true title: Authenticated type: boolean domain: description: The name of this domain. readOnly: true title: Domain Name type: string verification_email: description: The e-mail address receiving the two-factor challenge for this domain. readOnly: true title: Verification Email type: string verification_sent: description: The date/time that the two-factor challenge was sent to the verification email. format: date-time readOnly: true title: Verification Challenge Sent type: string verified: description: Whether the domain has been verified for sending. readOnly: true title: Verified type: boolean title: Verified Domains 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 domain info tags: - verifiedDomains x-custom-config: methodNameCamel: getDomain methodNameSnake: get_domain "/verified-domains/{domain_name}/actions/verify": post: deprecated: false description: Verify a domain for sending. operationId: verifyDomain parameters: - description: The domain name. in: path name: domain_name required: true schema: type: string x-title: Domain Name requestBody: content: application/json: schema: description: Submit a response to the verification challenge and verify a domain for sending. properties: code: description: The code that was sent to the email address provided when adding a new domain to verify. title: Verification Code type: string required: - code title: Verify a domain for sending. type: object required: true responses: "200": content: application/json: schema: description: The verified domains currently on the account. properties: authenticated: description: Whether domain authentication is enabled for this domain. readOnly: true title: Authenticated type: boolean domain: description: The name of this domain. readOnly: true title: Domain Name type: string verification_email: description: The e-mail address receiving the two-factor challenge for this domain. readOnly: true title: Verification Email type: string verification_sent: description: The date/time that the two-factor challenge was sent to the verification email. format: date-time readOnly: true title: Verification Challenge Sent type: string verified: description: Whether the domain has been verified for sending. readOnly: true title: Verified type: boolean title: Verified Domains type: object application/problem+json: schema: description: The verified domains currently on the account. properties: authenticated: description: Whether domain authentication is enabled for this domain. readOnly: true title: Authenticated type: boolean domain: description: The name of this domain. readOnly: true title: Domain Name type: string verification_email: description: The e-mail address receiving the two-factor challenge for this domain. readOnly: true title: Verification Email type: string verification_sent: description: The date/time that the two-factor challenge was sent to the verification email. format: date-time readOnly: true title: Verification Challenge Sent type: string verified: description: Whether the domain has been verified for sending. readOnly: true title: Verified type: boolean title: Verified Domains type: object description: The domain being verified for sending. 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 domain tags: - verifiedDomains x-custom-config: methodNameCamel: submitDomainVerification methodNameSnake: submit_domain_verification components: requestBodies: postAutomationsIdEmailsIdQueueBody: content: application/json: schema: description: Information about subscribers in an Automation email queue. properties: email_address: description: The list member's email address. title: Email Address type: string required: - email_address title: Subscriber in Automation Queue type: object required: true postCampaignFoldersBody: content: application/json: schema: description: A folder used to organize campaigns. properties: name: description: Name to associate with the folder. title: Folder Name type: string required: - name title: Campaign Folder type: object required: true postEcommerceStoresIdProductsIdVariantsBody: content: application/json: schema: 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 required: true postFileManagerFoldersBody: content: application/json: schema: description: An individual folder listed in the File Manager. properties: name: description: The name of the folder. title: Folder Name type: string required: - name title: Gallery Folder type: object required: true postListsIdInterestCategoriesBody: content: application/json: schema: description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: display_order: description: The order that the categories are displayed in the list. Lower numbers display first. title: Display Order type: integer title: description: The text description of this category. This field appears on signup forms and is often phrased as a question. title: Name type: string type: description: Determines how this category’s interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden title: Display Type type: string required: - title - type title: Interest Category type: object required: true postListsIdInterestCategoriesIdInterestsBody: content: application/json: schema: description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: display_order: description: The display order for interests. title: Display Order type: integer name: description: The name of the interest. This can be shown publicly on a subscription form. title: Interest Name type: string required: - name title: Interest type: object required: true postListsIdMembersIdNotesBody: content: application/json: schema: description: A specific note for a specific member. properties: note: description: The content of the note. Note length is limited to 1,000 characters. title: Note type: string title: Member Notes type: object required: true postListsIdWebhooksBody: content: application/json: schema: description: Configure a webhook for the given list. properties: events: description: The events that can trigger the webhook and whether they are enabled. properties: campaign: description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true title: Campaign Sent type: boolean cleaned: description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true title: Cleaned type: boolean profile: description: Whether the webhook is triggered when a subscriber's profile is updated. example: true title: Profile Updated type: boolean subscribe: description: Whether the webhook is triggered when a list subscriber is added. example: true title: Subscribed type: boolean unsubscribe: description: Whether the webhook is triggered when a list member unsubscribes. example: true title: Unsubscribed type: boolean upemail: description: Whether the webhook is triggered when a subscriber's email address is changed. example: true title: Email Address Updated type: boolean title: Events type: object sources: description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: admin: description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true title: Admin type: boolean api: description: Whether the webhook is triggered by actions initiated via the API. example: true title: API type: boolean user: description: Whether the webhook is triggered by subscriber-initiated actions. example: true title: User type: boolean title: Sources type: object url: description: A valid URL for the Webhook. example: http://yourdomain.com/webhook title: URL type: string title: Add Webhook type: object required: true postTemplateFoldersBody: content: application/json: schema: description: A folder used to organize templates. properties: name: description: The name of the folder. title: Folder Name type: string required: - name title: Template Folder type: object required: true postTemplatesBody: content: application/json: schema: description: Information about a specific template. properties: folder_id: description: The id of the folder the template is currently in. example: a4b830b title: Folder ID type: string html: description: The raw HTML for the template. We support the Mailchimp [Template Language](https://mailchimp.com/help/getting-started-with-mailchimps-template-language/) in any HTML code passed via the API. title: Template HTML type: string name: description: The name of the template. example: Freddie's Jokes title: Template Name type: string required: - name - html title: Template Instance type: object required: true securitySchemes: basicAuth: scheme: basic type: http x-doc-structure: resources: abuse-reports: description: Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program. paths: - /lists/{list_id}/abuse-reports - /lists/{list_id}/abuse-reports/{report_id} title: Abuse Reports account-exports: description: Generate a new export or download a finished export. paths: - /account-exports - /account-exports/{export_id} title: Account Exports authorized-apps: description: Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints. paths: - /authorized-apps - /authorized-apps/{app_id} title: Authorized Apps automation: description: Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues. Does not include Customer Journeys. paths: - /automations - /automations/{workflow_id} - /automations/{workflow_id}/actions/start-all-emails - /automations/{workflow_id}/actions/pause-all-emails - /automations/{workflow_id}/actions/archive subResources: - automation-email - automation-removed-subscribers title: Automations automation-email: description: Manage individual emails in a classic automation workflow. paths: - /automations/{workflow_id}/emails - /automations/{workflow_id}/emails/{workflow_email_id} - /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause - /automations/{workflow_id}/emails/{workflow_email_id}/actions/start subResources: - automation-email-queue title: Emails automation-email-queue: description: Manage list member queues for classic automation emails. paths: - /automations/{workflow_id}/emails/{workflow_email_id}/queue - /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} subResources: [] title: Queue automation-removed-subscribers: description: Remove subscribers from a classic automation workflow. paths: - /automations/{workflow_id}/removed-subscribers - /automations/{workflow_id}/removed-subscribers/{subscriber_hash} subResources: [] title: Removed Subscribers batch-operations: description: Use batch operations to complete multiple operations with a single call. paths: - /batches - /batches/{batch_id} title: Batch Operations batch-webhooks: description: "Manage webhooks for batch operations. " paths: - /batch-webhooks - /batch-webhooks/{batch_webhook_id} title: Batch Webhooks campaign-abuse: description: Get information about campaign abuse complaints. paths: - /reports/{campaign_id}/abuse-reports - /reports/{campaign_id}/abuse-reports/{report_id} title: Campaign Abuse campaign-advice: description: Get recent feedback based on a campaign's statistics. paths: - /reports/{campaign_id}/advice title: Campaign Advice campaign-checklist: description: Review the send checklist for your campaign, and resolve any issues before sending. paths: - /campaigns/{campaign_id}/send-checklist title: Send Checklist campaign-content: description: Manage the HTML, plain-text, and template content for your Mailchimp campaigns. paths: - /campaigns/{campaign_id}/content title: Content campaign-ecommerce-product-activity: description: Ecommerce product activity report for a campaign. paths: - /reports/{campaign_id}/ecommerce-product-activity title: Ecommerce Product Activity campaign-feedback: description: Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign. paths: - /campaigns/{campaign_id}/feedback - /campaigns/{campaign_id}/feedback/{feedback_id} title: Feedback campaign-folders: description: Organize your campaigns using folders. paths: - /campaign-folders - /campaign-folders/{folder_id} title: Campaign Folders campaigns: description: Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account. paths: - /campaigns - /campaigns/{campaign_id} - /campaigns/{campaign_id}/actions/cancel-send - /campaigns/{campaign_id}/actions/send - /campaigns/{campaign_id}/actions/schedule - /campaigns/{campaign_id}/actions/unschedule - /campaigns/{campaign_id}/actions/pause - /campaigns/{campaign_id}/actions/resume - /campaigns/{campaign_id}/actions/replicate - /campaigns/{campaign_id}/actions/test - /campaigns/{campaign_id}/actions/create-resend subResources: - campaign-feedback - campaign-checklist - campaign-content title: Campaigns chimp-chatter: description: Get the latest Chimp Chatter activity from your account. paths: - /activity-feed/chimp-chatter title: Chimp Chatter Activity click-reports: description: Get detailed information about links clicked in campaigns. paths: - /reports/{campaign_id}/click-details - /reports/{campaign_id}/click-details/{link_id} subResources: - link-clickers title: Click Reports connected-sites: description: Manage sites you've connected to your Mailchimp account. paths: - /connected-sites - /connected-sites/{connected_site_id} - /connected-sites/{connected_site_id}/actions/verify-script-installation title: Connected Sites conversation-messages: description: Manage messages in a specific campaign conversation. paths: - /conversations/{conversation_id}/messages - /conversations/{conversation_id}/messages/{message_id} title: Messages conversations: description: Conversation tracking lets you view subscribers' replies to your campaigns in your Mailchimp account. paths: - /conversations - /conversations/{conversation_id} subResources: - conversation-messages title: Conversations customer-journeys-journeys-steps-actions: description: Manage Customer Journey automated workflows paths: - /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger subResources: [] title: Customer Journeys domain-performance-reports: description: Get statistics for the top-performing domains from a campaign. paths: - /reports/{campaign_id}/domain-performance title: Domain Performance ecommerce-cart-lines: description: Each Cart contains one or more Cart Lines, which represent a specific Product Variant that a Customer has added to their shopping cart. paths: - /ecommerce/stores/{store_id}/carts/{cart_id}/lines - /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} title: Cart Lines ecommerce-carts: description: Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumer’s shopping cart pending a successful Order. paths: - /ecommerce/stores/{store_id}/carts - /ecommerce/stores/{store_id}/carts/{cart_id} subResources: - ecommerce-cart-lines title: Carts ecommerce-customers: description: Add Customers to your Store to track their orders and to view E-Commerce Data for your Mailchimp lists and campaigns. Each Customer is connected to a Mailchimp list member, so adding a Customer can also add or update a list member. paths: - /ecommerce/stores/{store_id}/customers - /ecommerce/stores/{store_id}/customers/{customer_id} title: Customers ecommerce-order-lines: description: Each Order contains one or more Order Lines, which represent a specific Product Variant that a Customer purchases. paths: - /ecommerce/stores/{store_id}/orders/{order_id}/lines - /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} title: Order Lines ecommerce-orders: description: Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your Mailchimp account. paths: - /ecommerce/orders - /ecommerce/stores/{store_id}/orders - /ecommerce/stores/{store_id}/orders/{order_id} subResources: - ecommerce-order-lines title: Orders ecommerce-product-images: description: A Product Image represents a specific product image. paths: - /ecommerce/stores/{store_id}/products/{product_id}/images - /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} title: Product Images ecommerce-product-variants: description: A Product Variant represents a specific item for purchase, and is contained within a parent Product. At least one Product Variant is required for each Product. paths: - /ecommerce/stores/{store_id}/products/{product_id}/variants - /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} title: Product Variants ecommerce-products: description: E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant. paths: - /ecommerce/stores/{store_id}/products - /ecommerce/stores/{store_id}/products/{product_id} subResources: - ecommerce-product-variants - ecommerce-product-images title: Products ecommerce-promo-codes: description: Promo codes can be created for a given price rule. All the promo codes under a price rule share the generic information defined for that rule like the amount, type, expiration date etc. Promo code defines the more specific information about a promo code like the actual code, redemption_url, usage_count, etc that's unique to a code. Promo Code must be defined under a promo rule. paths: - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} title: Promo Codes ecommerce-promo-rules: description: Promo Rules help you create promo codes for your campaigns. Promo Rules define generic information about promo codes like expiration time, start time, amount of discount being offered etc. For a given promo rule you can define if it's a percentage discount or a fixed amount and if it applies for the order as a whole or if it's per item or free shipping. You can then create promo codes for this price rule. Promo codes contain the actual code that is applied at checkout along with some other information. Price Rules have one to many relationship with promo codes. paths: - /ecommerce/stores/{store_id}/promo-rules - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} subResources: - ecommerce-promo-codes title: Promo Rules ecommerce-stores: description: Connect your E-commerce Store to Mailchimp to take advantage of powerful reporting and personalization features and to learn more about your customers. paths: - /ecommerce/stores - /ecommerce/stores/{store_id} subResources: - ecommerce-customers - ecommerce-orders - ecommerce-products - ecommerce-carts - ecommerce-promo-rules title: E-commerce Stores eepurl-reports: description: Get a summary of social activity for the campaign, tracked by EepURL. paths: - /reports/{campaign_id}/eepurl title: EepURL Reports email-activity-reports: description: Get list member activity for a specific campaign. paths: - /reports/{campaign_id}/email-activity - /reports/{campaign_id}/email-activity/{subscriber_hash} title: Email Activity facebook-ads: description: Get information about Facebook Ads. paths: - /facebook-ads - /facebook-ads/{outreach_id} title: Facebook Ads file-manager: description: Manage files for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms. paths: [] subResources: - file-manager-folders - file-manager-files title: File Manager file-manager-files: description: Manage specific files in the File Manager for your Mailchimp account. paths: - /file-manager/files - /file-manager/files/{file_id} title: File Manager Files file-manager-folders: description: Manage specific folders in the File Manager for your Mailchimp account. paths: - /file-manager/folders - /file-manager/folders/{folder_id} subResources: - file-manager-folders-files title: File Manager Folders file-manager-folders-files: description: Manage specific files in a folder. paths: - /file-manager/folders/{folder_id}/files title: Files in Folder interest-categories: description: Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to 'group titles' in the Mailchimp application. paths: - /lists/{list_id}/interest-categories - /lists/{list_id}/interest-categories/{interest_category_id} subResources: - interests title: Interest Categories interests: description: Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. paths: - /lists/{list_id}/interest-categories/{interest_category_id}/interests - /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} title: Interests landing-pages: description: Manage your Landing Pages, including publishing and unpublishing. paths: - /landing-pages - /landing-pages/{page_id} - /landing-pages/{page_id}/actions/publish - /landing-pages/{page_id}/actions/unpublish subResources: - landing-pages_content title: Landing Pages landing-pages_content: description: The HTML content for your Mailchimp landing pages. paths: - /landing-pages/{page_id}/content title: Content link-clickers: description: Get information about specific subscribers who clicked on links in a campaign. paths: - /reports/{campaign_id}/click-details/{link_id}/members - /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash} title: Click Reports Members list-activity: description: Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days. paths: - /lists/{list_id}/activity title: Activity list-clients: description: Get information about the most popular email clients for subscribers in a specific Mailchimp list. paths: - /lists/{list_id}/clients title: Clients list-growth-history: description: View a summary of the month-by-month growth activity for a specific list. paths: - /lists/{list_id}/growth-history - /lists/{list_id}/growth-history/{month} title: Growth History list-locations: description: Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address. paths: - /lists/{list_id}/locations title: Locations list-member-activity: description: Get details about a subscriber's recent activity. Use the new activity-feed endpoint to access more events for a given contact. paths: - /lists/{list_id}/members/{subscriber_hash}/activity title: Member Activity list-member-activity-feed: description: Get details about a subscriber's recent activity. paths: - /lists/{list_id}/members/{subscriber_hash}/activity-feed title: Member Activity Feed list-member-events: description: "Use the Events endpoint to collect website or in-app actions and trigger targeted automations. " paths: - /lists/{list_id}/members/{subscriber_hash}/events title: Events list-member-goal: description: Get information about recent goal events for a specific list member. paths: - /lists/{list_id}/members/{subscriber_hash}/goals title: Member Goals list-member-notes: description: Retrieve recent notes for a specific list member. paths: - /lists/{list_id}/members/{subscriber_hash}/notes - /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} title: Member Notes list-member-tags: description: Manage all the tags that have been assigned to a contact. paths: - /lists/{list_id}/members/{subscriber_hash}/tags title: Member Tags list-members: description: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. paths: - /lists/{list_id}/members - /lists/{list_id}/members/{subscriber_hash} - /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent subResources: - list-member-activity - list-member-activity-feed - list-member-goal - list-member-notes - list-member-tags - list-member-events title: Members list-merges: description: Manage merge fields for an audience. See [Merge Field documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/) for more. paths: - /lists/{list_id}/merge-fields - /lists/{list_id}/merge-fields/{merge_id} subResources: [] title: Merge Fields list-segment-members: description: Manage list members in a saved segment. paths: - /lists/{list_id}/segments/{segment_id}/members - /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash} title: Segment Members list-segments: description: Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts. paths: - /lists/{list_id}/segments - /lists/{list_id}/segments/{segment_id} subResources: - list-segment-members title: Segments list-signup-forms: description: Manage list signup forms. paths: - /lists/{list_id}/signup-forms title: Signup Forms list-surveys: description: Get survey data for this audience. paths: - /lists/{list_id}/surveys - /lists/{list_id}/surveys/{survey_id} - /lists/{list_id}/surveys/{survey_id}/actions/publish - /lists/{list_id}/surveys/{survey_id}/actions/unpublish - /lists/{list_id}/surveys/{survey_id}/actions/create-email title: Surveys list-webhooks: description: Manage webhooks for a specific Mailchimp list. paths: - /lists/{list_id}/webhooks - /lists/{list_id}/webhooks/{webhook_id} title: Webhooks lists: description: Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts. paths: - /lists - /lists/{list_id} subResources: - interest-categories - list-segments - abuse-reports - list-activity - list-clients - list-growth-history - list-imports - list-members - list-merges - list-webhooks - list-signup-forms - list-locations - lists-tags-search - prebuilt-segments - list-preview-segment - list-surveys title: Lists/Audiences lists-tags-search: description: Search for tags on a list by name. paths: - /lists/{list_id}/tag-search title: Tag Search location-reports: description: Get top open locations for a specific campaign. paths: - /reports/{campaign_id}/locations title: Location open-reports: description: "Get a detailed report about any emails in a specific campaign that were opened by the recipient. " paths: - /reports/{campaign_id}/open-details - /reports/{campaign_id}/open-details/{subscriber_hash} title: Campaign Open Reports ping: description: A health check endpoint for Mailchimp API 3.0. paths: - /ping title: Ping reporting: description: Reporting for various campaign types. paths: [] subResources: - reporting-facebook-ads - reporting-google-ads - reporting-landing-pages - reporting-postcards - reporting-social-posts - reporting-surveys - reporting-websites title: Reporting reporting-facebook-ads: description: "Get information about Facebook Ad reports. " paths: - /reporting/facebook-ads - /reporting/facebook-ads/{outreach_id} - /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity title: Facebook Ads reporting-landing-pages: description: Get information about Landing Page reports. paths: - /reporting/landing-pages - /reporting/landing-pages/{outreach_id} title: Landing Pages reporting-surveys: description: Survey reports paths: - /reporting/surveys - /reporting/surveys/{outreach_id} subResources: - reporting-surveys-questions - reporting-surveys-responses title: Surveys reporting-surveys-questions: description: Survey question reports paths: - /reporting/surveys/{outreach_id}/questions - /reporting/surveys/{outreach_id}/questions/{question_id} subResources: - reporting-surveys-questions-answers title: Survey Questions reporting-surveys-questions-answers: description: Survey question answers paths: - /reporting/surveys/{outreach_id}/questions/{question_id}/answers title: Survey Question Answers reporting-surveys-responses: description: Survey response reports paths: - /reporting/surveys/{outreach_id}/responses - /reporting/surveys/{outreach_id}/responses/{response_id} title: Survey Responses reports: description: "Manage campaign reports for your Mailchimp account. All Reports endpoints are read-only. Mailchimp's campaign and automation reports analyze clicks, opens, subscribers' social activity, e-commerce data, and more. Note: Campaign IDs for A/B Testing Campaigns are available through the Campaign API Endpoint's Read method." paths: - /reports - /reports/{campaign_id} subResources: - campaign-abuse - campaign-advice - click-reports - domain-performance-reports - eepurl-reports - email-activity-reports - location-reports - sent-to-reports - sub-reports - unsub-reports - open-reports - campaign-ecommerce-product-activity title: Reports root: description: The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account. paths: - / subResources: [] title: API Root search-campaigns: description: Search all of an account's campaigns for the specified query terms. paths: - /search-campaigns title: Search Campaigns search-members: description: Search the account or a specific list for members that match the specified query terms. paths: - /search-members title: Search Members sent-to-reports: description: Get details about campaign recipients. paths: - /reports/{campaign_id}/sent-to - /reports/{campaign_id}/sent-to/{subscriber_hash} title: Sent To sub-reports: description: A list of reports for child campaigns of a specific parent campaign. For example, use this endpoint to view Multivariate, RSS, and A/B Testing Campaign reports. paths: - /reports/{campaign_id}/sub-reports title: Sub-Reports template-default-content: description: Manage the default content for a Mailchimp template. paths: - /templates/{template_id}/default-content title: Default Content template-folders: description: Organize your templates using folders. paths: - /template-folders - /template-folders/{folder_id} title: Template Folders templates: description: "Manage your Mailchimp templates. A template is an HTML file used to create the layout and basic design for a campaign. " paths: - /templates - /templates/{template_id} subResources: - template-default-content title: Templates unsub-reports: description: Get information about list members who unsubscribed from a specific campaign. paths: - /reports/{campaign_id}/unsubscribed - /reports/{campaign_id}/unsubscribed/{subscriber_hash} title: Unsubscribes verified-domains: description: Manage the domains on your account that can be used for sending email campaigns. paths: - /verified-domains - /verified-domains/{domain_name} - /verified-domains/{domain_name}/actions/verify subresources: [] title: Verified Domains x-hidden: false